Class: FormCellControlProxy¶
Hierarchy¶
-
FormCellControlProxy
Implements¶
Summary¶
Constructors¶
Properties¶
Class Properties¶
Currently none in this class.
Inherited Properties¶
Accessors¶
Class Accessors¶
Inherited Accessors¶
Methods¶
Class Methods¶
- clearFocus
- createAttachmentEntry
- dataQueryBuilder
- getCaption
- getCollection
- getEditable
- getEnable
- getEnabled
- getHelperText
- getRequiredIndicator
- getRequiredIndicatorStyle
- getTargetSpecifier
- getValidation
- getVisible
- reset
- setCaption
- setEditable
- setEnable
- setEnabled
- setFocus
- setHelperText
- setRequiredIndicator
- setRequiredIndicatorStyle
- setTargetSpecifier
Inherited Methods¶
Constructors¶
constructor¶
+ new FormCellControlProxy(context: IContext): FormCellControlProxy
Overrides ControlProxy.constructor
Parameters:
| Name | Type |
|---|---|
context |
IContext |
Returns: FormCellControlProxy
Accessors¶
searchString¶
• searchString:
Implementation of IFormCellProxy.searchString
visible¶
• visible:
Implementation of IFormCellProxy.visible
Methods¶
clearFocus¶
▸ clearFocus(): void
Implementation of IFormCellProxy
Returns: void
createAttachmentEntry¶
▸ createAttachmentEntry(attachmentPath: string, entitySet: string, property: string, readLink: string, service: string, encodeURI: boolean): any
Implementation of IFormCellProxy
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
attachmentPath |
string | - | the path for the attachment file |
entitySet |
string | - | entity set name |
property |
string | - | the property of the entity set |
readLink |
string | - | readlink string |
service |
string | - | service name |
encodeURI |
boolean | true | whether the URI need to be encoded, default value is true |
Returns: any
an object with all information for the attachment entry or undefined if the attachment is invalid
dataQueryBuilder¶
▸ dataQueryBuilder(query: string): DataQueryBuilder
Implementation of IFormCellProxy
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
query |
string | undefined | the query string |
Returns: DataQueryBuilder
getCaption¶
▸ getCaption(): string
Implementation of IFormCellProxy
Overrides ControlProxy.getCaption
Returns: string
getCollection¶
▸ getCollection(): object[]
Implementation of IFormCellProxy
Returns: object[]
getEditable¶
▸ getEditable(): boolean
Implementation of IFormCellProxy
Returns: boolean
getEnable¶
▸ getEnable(): boolean
Implementation of IFormCellProxy
Returns: boolean
getEnabled¶
▸ getEnabled(): boolean
Implementation of IFormCellProxy
Returns: boolean
getHelperText¶
▸ getHelperText(): string
Implementation of IFormCellProxy
Returns: string
getRequiredIndicator¶
▸ getRequiredIndicator(): string
Implementation of IFormCellProxy
Returns: string
getRequiredIndicatorStyle¶
▸ getRequiredIndicatorStyle(): string
Implementation of IFormCellProxy
Returns: string
getTargetSpecifier¶
▸ getTargetSpecifier(): IFormCellTargetProxy
Implementation of IFormCellProxy
Returns: IFormCellTargetProxy
getValidation¶
▸ getValidation(): IFormCellValidationProxy
Implementation of IFormCellProxy
Returns: IFormCellValidationProxy
getVisible¶
▸ getVisible(): boolean
Implementation of IFormCellProxy
Returns: boolean
returns true if the control is visible otherwise false.
reset¶
▸ reset(): Promise‹any›
Implementation of IFormCellProxy
Returns: Promise‹any›
setCaption¶
▸ setCaption(caption: string): Promise‹any›
Implementation of IFormCellProxy
Parameters:
| Name | Type | Description |
|---|---|---|
caption |
string | value to set. |
Returns: Promise‹any›
setEditable¶
▸ setEditable(isEditable: boolean): Promise‹any›
Implementation of IFormCellProxy
Overrides ControlProxy.setEditable
Parameters:
| Name | Type | Description |
|---|---|---|
isEditable |
boolean | true if this form cell is editable. False otherwise. |
Returns: Promise‹any›
setEnable¶
▸ setEnable(isEnabled: boolean): Promise‹any›
Implementation of IFormCellProxy
Parameters:
| Name | Type | Description |
|---|---|---|
isEnabled |
boolean | true enables and false disables. |
Returns: Promise‹any›
setEnabled¶
▸ setEnabled(isEnabled: boolean): Promise‹any›
Implementation of IFormCellProxy
Parameters:
| Name | Type | Description |
|---|---|---|
isEnabled |
boolean | true enables and false disables. |
Returns: Promise‹any›
setFocus¶
▸ setFocus(keyboardVisibility: string): void
Implementation of IFormCellProxy
Parameters:
| Name | Type | Description |
|---|---|---|
keyboardVisibility |
string | This parameter allows you to either show or hide the on-screen keyboard (setting applies only to Android devices, iOS devices will ignore this setting). Available values: - Auto (Default value. Show the on-screen keyboard only if there is no physical or bluetooth keyboard attached to the device) - AlwaysShow - AlwaysHide |
Returns: void
setHelperText¶
▸ setHelperText(helperText: string): Promise‹any›
Implementation of IFormCellProxy
Parameters:
| Name | Type | Description |
|---|---|---|
helperText |
string | value to set. |
Returns: Promise‹any›
setRequiredIndicator¶
▸ setRequiredIndicator(indicator: string | Boolean): Promise‹any›
Parameters:
| Name | Type | Description |
|---|---|---|
indicator |
string | Boolean | value to set. |
Returns: Promise‹any›
setRequiredIndicatorStyle¶
▸ setRequiredIndicatorStyle(requiredIndicatorStyle: string): Promise‹any›
Implementation of IFormCellProxy
Parameters:
| Name | Type |
|---|---|
requiredIndicatorStyle |
string |
Returns: Promise‹any›
setTargetSpecifier¶
▸ setTargetSpecifier(specifier: IFormCellTargetProxy, redraw?: boolean): Promise‹any›
Implementation of IFormCellProxy
Parameters:
| Name | Type | Description |
|---|---|---|
specifier |
IFormCellTargetProxy | specifier for the FormCell control |
redraw? |
boolean | whether to redraw formcell |
Returns: Promise‹any›