Interface: IControlProxy¶
Hierarchy¶
-
IControlProxy
Implemented by¶
- ActionBarItemProxy
- ActionBarProxy
- AttachmentFormCellProxy
- ButtonFormCellControlProxy
- ButtonTableButtonProxy
- ControlProxy
- DatePickerFormCellProxy
- DurationPickerFormCellProxy
- ExtensionFormCellProxy
- FioriToolbarButtonProxy
- FioriToolbarItemProxy
- FioriToolbarProxy
- FormCellContainerProxy
- FormCellControlProxy
- InlineSignatureCaptureFormCellProxy
- KeyValueItemProxy
- LabelFormCellProxy
- ListPickerFormCellProxy
- MultiSorterFormCellProxy
- NoteFormCellProxy
- SectionFooterProxy
- SectionHeaderButtonProxy
- SectionHeaderIconProxy
- SectionHeaderItemProxy
- SectionHeaderLabelProxy
- SectionHeaderProxy
- SectionedTableProxy
- SegmentedFormCellProxy
- SideDrawerControlProxy
- SignatureCaptureFormCellProxy
- SimplePropertyFormCellProxy
- TabControlProxy
- TabItemProxy
- TitleFormCellProxy
- ToolbarItemProxy
- ToolbarProxy
Summary¶
Properties¶
Class Properties¶
Currently none in this class.
Inherited Properties¶
Methods¶
Class Methods¶
- applyValidation
- clearValidation
- clearValidationOnValueChange
- getCaption
- getName
- getPageProxy
- getType
- getValue
- isContainer
- redraw
- setEditable
- setStyle
- setValidationProperty
- setValue
- setVisible
Inherited Methods¶
Methods¶
applyValidation¶
▸ applyValidation(): any
Returns: any
clearValidation¶
▸ clearValidation(): any
Returns: any
clearValidationOnValueChange¶
▸ clearValidationOnValueChange(): any
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
Returns: boolean
returns true if the control is a container control. Otherwise, returns false.
redraw¶
▸ redraw(): any
Returns: any
setEditable¶
▸ setEditable(value: boolean): any
Parameters:
| Name | Type | Description |
|---|---|---|
value |
boolean | editable setting |
Returns: any
this - allows chaining
setStyle¶
▸ setStyle(styleClass: string, subView: string): any
Parameters:
| Name | Type | Description |
|---|---|---|
styleClass |
string | The name of the style class to be applied |
subView |
string | The name of the subview to apply the style to. If this is '', the style is applied to the entire control. If the style format is nested controls, we could combine them with slash '/', such as 'parent/child'. |
Returns: any
setValidationProperty¶
▸ setValidationProperty(key: string, value: any): IControlProxy
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
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
Parameters:
| Name | Type | Description |
|---|---|---|
value |
boolean | visible state |
redraw |
boolean | true if redraw after set the visible state |
Returns: any