Skip to content

Class: AIFeedbackFormCellProxy

AIFeedbackFormCellProxy is a developer-facing interface that provides access to an AIFeedback control and allows customizations. In addition, it provides access to the IFormCellProxy interface.

Hierarchy

Implements

Summary

Constructors

Properties

Class Properties

Currently none in this class.

Inherited Properties

Accessors

Class Accessors

Currently none in this class.

Inherited Accessors

Methods

Class Methods

Inherited Methods

Constructors

Constructor

+ new AIFeedbackFormCellProxy(context: IContext): AIFeedbackFormCellProxy

Inherited from FormCellControlProxy.constructor

Parameters:

Name Type
context IContext

Returns: AIFeedbackFormCellProxy

Methods

getCaption

getCaption(): string

Returns the Caption property value defined for the AIFeedback FormCell's control.

Implementation of IAIFeedbackFormCellProxy.getCaption Overrides FormCellControlProxy.getCaption

Returns: string


getStyle

getStyle(): string

Returns the current style classes applied to the AIFeedback FormCell's control.

Implementation of IAIFeedbackFormCellProxy.getStyle

Returns: string


getValue

getValue(): string

Returns the current value of the AIFeedback FormCell's control. Possible values are: "None", "Up", "Down".

Implementation of IAIFeedbackFormCellProxy.getValue Overrides FormCellControlProxy.getValue

Returns: string


setCaption

setCaption(caption: string): Promise<any>

Sets the Caption property of the AIFeedback FormCell's control.

Implementation of IAIFeedbackFormCellProxy.setCaption Overrides FormCellControlProxy.setCaption

Parameters:

Name Type Description
caption string value to set.

Returns: Promise<any>


setStyle

setStyle(styleClass: string, target?: string): AIFeedbackFormCellProxy

Sets the style of the AIFeedback FormCell's control. Supported target values are: "Background", "Caption", "VoteButtons". When no target is specified, the style is applied to the entire control.

Implementation of IAIFeedbackFormCellProxy.setStyle Overrides FormCellControlProxy.setStyle

Parameters:

Name Type Description
styleClass string the style class name or JSON string.
target? string optional target sub-view to apply the style to.

Returns: AIFeedbackFormCellProxy

this - allows chaining.


setValue

setValue(value: string, notify?: boolean = true): AIFeedbackFormCellProxy

Sets the value of the AIFeedback FormCell's control. Accepted values are: "None", "Up", "Down" (case-sensitive). If an invalid value is provided (e.g. "Upp" or "up"), it will be silently reset to "None".

Implementation of IAIFeedbackFormCellProxy.setValue Overrides FormCellControlProxy.setValue

Parameters:

Name Type Description
value string value to set.
notify? boolean = true whether to trigger the OnValueChange event on the FormCell's control.

Returns: AIFeedbackFormCellProxy

this - allows chaining.