Interface: IControlProxy¶
A designer-facing interface that provides access to a control.
It is passed to rules to provide access to a control for application specific customizations.
Hierarchy¶
-
IControlProxy
Implemented by¶
- AttachmentFormCellProxy
- ButtonFormCellControlProxy
- ControlProxy
- DatePickerFormCellProxy
- DurationPickerFormCellProxy
- FormCellContainerProxy
- FormCellControlProxy
- InlineSignatureCaptureFormCellProxy
- ListPickerFormCellProxy
- NoteFormCellProxy
- SectionedTableProxy
- SegmentedFormCellProxy
- SideDrawerControlProxy
- SignatureCaptureFormCellProxy
- SimplePropertyFormCellProxy
- TabControlProxy
- TabItemProxy
- TitleFormCellProxy
- ToolbarItemProxy
- ToolbarProxy
Summary¶
Properties¶
Class Properties¶
Inherited Properties¶
Methods¶
Class Methods¶
- applyValidation
- clearValidation
- clearValidationOnValueChange
- getCaption
- getName
- getPageProxy
- getType
- getValue
- isContainer
- redraw
- setEditable
- setStyle
- setValidationProperty
- setValue
- setVisible
Inherited Methods¶
Properties¶
Methods¶
applyValidation¶
▸ applyValidation(): any
Applies the validation view, if it's supported for the given control
Returns: any
clearValidation¶
▸ clearValidation(): any
Hides the validaiton view. Shorter version of: clientAPI.setupValidationProperties('ValidationViewIsHidden', true).applyValidation();
Returns: any
clearValidationOnValueChange¶
▸ clearValidationOnValueChange(): any
Hides the validaiton view while changing value
Returns: any
getCaption¶
▸ getCaption(): string
Returns: string
the caption of the contol
getName¶
▸ getName(): string
Returns: string
the name of the contol
getPageProxy¶
▸ getPageProxy(): IPageProxy
Returns: IPageProxy
the Page, which the control belongs to
getType¶
▸ getType(): string
Returns: string
the type of the contol
getValue¶
▸ getValue(): any
Returns: any
the value of the contol
isContainer¶
▸ isContainer(): boolean
Determine if the control is a container control
Returns: boolean
returns true if the control is a container control. Otherwise, returns false.
redraw¶
▸ redraw(): any
Use this method to redraw the control. In cases where a control does not have redraw semantics the control's container will redraw
Returns: any
setEditable¶
▸ setEditable(value
: boolean): any
Sets the controls editable state
Parameters:
Name | Type | Description |
---|---|---|
value |
boolean | editable setting |
Returns: any
this - allows chaining
setStyle¶
▸ setStyle(styleClass
: string, subView
: string): any
Parameters:
Name | Type |
---|---|
styleClass |
string |
subView |
string |
Returns: any
setValidationProperty¶
▸ setValidationProperty(key
: string, value
: any): IControlProxy
Sets the validationProperties parameter of the underlying Observable. Currently only the FormCell Observable is supported.
This will not cause the UI to rerender. To redraw the form cell, use the applyValidation API.
Parameters:
Name | Type | Description |
---|---|---|
key |
string | the key of the validaiton property Available keys: - SeparatorBackgroundColor (hex color as string e.g.: 'ffffff') - SeparatorIsHidden (boolean) - ValidationMessage (string) - ValidationMessageColor (hex color as string e.g.: 'ffffff') - ValidationViewBackgroundColor (hex color as string e.g.: 'ffffff') - ValidationViewIsHidden (boolean) |
value |
any | the value of the validation property |
Returns: IControlProxy
the current instance of the ControlProxy class
setValue¶
▸ setValue(value
: any, notify?
: boolean): any
Set the value in the control
Parameters:
Name | Type | Description |
---|---|---|
value |
any | value to be set |
notify? |
boolean | whether to send the notification |
Returns: any
this - allows chaining
setVisible¶
▸ setVisible(value
: boolean, redraw
: boolean): any
Sets the control's visible state with / without redraw
Parameters:
Name | Type | Description |
---|---|---|
value |
boolean | visible state |
redraw |
boolean | true if redraw after set the visible state |
Returns: any