Class: FormCellControlProxy¶
FormCellControlProxy is a developer-facing interface that provides access to a formcell control. It is passed to rules to provide access to a formcell control for application specific customizations.
Hierarchy¶
-
FormCellControlProxy
- DatePickerFormCellProxy
- ExtensionFormCellProxy
- SimplePropertyFormCellProxy
- NoteFormCellProxy
- AINoticeFormCellProxy
- AIFeedbackFormCellProxy
- LabelFormCellProxy
- StepperFormCellProxy
- MultiSorterFormCellProxy
- SegmentedFormCellProxy
- TitleFormCellProxy
- AttachmentFormCellProxy
- ButtonFormCellControlProxy
- ListPickerFormCellProxy
- InlineSignatureCaptureFormCellProxy
- SignatureCaptureFormCellProxy
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¶
- _clientAPIProps
- _getExecuteSource
- applyValidation
- base64StringToBinary
- binaryToBase64String
- callFunction
- clearValidation
- clearValidationOnValueChange
- convertFilterCriteriaArrayToJSONString
- convertJSONStringToFilterCriteriaArray
- count
- create
- createFilterCriteria
- createFilterSelection
- createLinkSpecifierProxy
- createSorterSelection
- deleteODataCacheImages
- dismissActivityIndicator
- downloadInProgressForPage
- downloadInProgressForReadLink
- evaluateTargetPath
- evaluateTargetPathForAPI
- executeAction
- formatBase64String
- formatCurrency
- formatDate
- formatDatetime
- formatNumber
- formatPercentage
- formatScientific
- formatTime
- getActionResult
- getAppClientData
- getAppearanceMode
- getAppEventData
- getAppName
- getAvailableThemes
- getBindingObject
- getCaption
- getCircularImage
- getClientData
- getDefinitionValue
- getEventData
- getGlobalDefinition
- getGlobalSideDrawerControlProxy
- getIconTextImage
- getLanguage
- getLogger
- getMobileServiceAppId
- getMobileServiceEndpointUrl
- getName
- getODataCacheImagePath
- getODataProvider
- getPageDefinition
- getPageProxy
- getParent
- getPasscodeSource
- getPendingDownload
- getReadLink
- getRegion
- getRegions
- getSAPPassportHeaderValue
- getSupportedLanguages
- getTheme
- getType
- getUseInAppCamera
- getValue
- getVersionInfo
- initializeLogger
- isAppInMultiUserMode
- isContainer
- isCurrentPage
- isDemoMode
- isDeviceCompliant
- isMediaLocal
- localizeText
- read
- redraw
- sendMobileServiceRequest
- sendRequest
- setApplicationIconBadgeNumber
- setDebugSettings
- setEditable
- setLanguage
- setMdkWindows
- setRegion
- setStyle
- setTheme
- setUseInAppCamera
- setValidationProperty
- setValue
- setVisible
- showActivityIndicator
- updateProgressBanner
Constructors¶
Constructor¶
+ new FormCellControlProxy(context: IContext): FormCellControlProxy
Overrides ControlProxy.constructor
Parameters:
| Name | Type |
|---|---|
| context | IContext |
Returns: FormCellControlProxy
Accessors¶
searchString¶
Get Signature¶
▸ getter
Get the user provided search string for a ListPicker FormCell
Returns¶
string
Returns the user provided search string for a ListPicker FormCell
Implementation of IFormCellProxy.searchString
visible¶
Get Signature¶
▸ getter
Property for viewing the current visible state of the control
Returns¶
boolean
Set Signature¶
▸ setter
Property for setting the current visible state of the control
Parameters¶
visible¶
boolean
Returns¶
void
Property for viewing and setting the current visible state of the control.
Implementation of IFormCellProxy.visible
Methods¶
clearFocus¶
▸ clearFocus(): void
Clear focus and close keyboard
Implementation of IFormCellProxy.clearFocus
Returns: void
createAttachmentEntry¶
▸ createAttachmentEntry(attachmentPath: string, entitySet: string, property: string, readLink: string, service: string, encodeURI?: boolean = true): any
Create an object for attachment entry Note: This function is for iOS & Android only
Implementation of IFormCellProxy.createAttachmentEntry
Parameters:
| Name | Type | 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 = undefined): DataQueryBuilder
Factory method to construct an instance of DataQueryBuilder
Implementation of IFormCellProxy.dataQueryBuilder
Parameters:
| Name | Type | Description |
|---|---|---|
| query? | string = undefined | the query string |
Returns: DataQueryBuilder
getCaption¶
▸ getCaption(): string
Returns the Caption property value defined for the control.
Implementation of IFormCellProxy.getCaption Overrides ControlProxy.getCaption
Returns: string
getCollection¶
▸ getCollection(): object[]
Get collection of ListPicker Formcell, SegmentedControl Formcell, and Filter Formcell based on the DisplayValue and ReturnValue
Implementation of IFormCellProxy.getCollection
Returns: object[]
getEditable¶
▸ getEditable(): boolean
Returns the Editable property value defined for the control.
Implementation of IFormCellProxy.getEditable
Returns: boolean
getEnable()¶
▸ getEnable(): boolean
Returns the Enabled property value defined for the control.
Returns: boolean
Deprecated¶
- use getEnabled()
Implementation of IFormCellProxy.getEnable
getEnabled¶
▸ getEnabled(): boolean
Returns the Enabled property value defined for the control.
Implementation of IFormCellProxy.getEnabled
Returns: boolean
getHelperText¶
▸ getHelperText(): string
Returns the HelperText property value defined for the control.
Implementation of IFormCellProxy.getHelperText
Returns: string
getRequiredIndicator¶
▸ getRequiredIndicator(): string
Returns the RequiredIndicator property value defined for the FormCell's control. Returns a String.
Implementation of IFormCellProxy.getRequiredIndicator
Returns: string
getRequiredIndicatorStyle¶
▸ getRequiredIndicatorStyle(): string
Returns the Styles.RequiredIndicator property value defined for the FormCell's control.
Implementation of IFormCellProxy.getRequiredIndicatorStyle
Returns: string
getTargetSpecifier¶
▸ getTargetSpecifier(): IFormCellTargetProxy
Get target specifier for this FormCell control
Implementation of IFormCellProxy.getTargetSpecifier
Returns: IFormCellTargetProxy
getValidation¶
▸ getValidation(): IFormCellValidationProxy
Returns the FormCellValidationProxy for the control
Implementation of IFormCellProxy.getValidation
Returns: IFormCellValidationProxy
getVisible¶
▸ getVisible(): boolean
Gets the control's visible state.
Implementation of IFormCellProxy.getVisible
Returns: boolean
returns true if the control is visible otherwise false.
reset¶
▸ reset(): Promise<any>
Reset the FormCell control. The function will resolve the FormCell's properties and redraw it The OnValueChange event of the FormCell control will not be triggered after resetting
Implementation of IFormCellProxy.reset
Returns: Promise<any>
setCaption¶
▸ setCaption(caption: string): Promise<any>
Sets the Caption property of the FormCell's control.
Implementation of IFormCellProxy.setCaption
Parameters:
| Name | Type | Description |
|---|---|---|
| caption | string | value to set. |
Returns: Promise<any>
setEditable¶
▸ setEditable(isEditable: boolean): Promise<any>
Sets the Editable property of the FormCell's control.
Implementation of IFormCellProxy.setEditable 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>
Sets the Enabled property of the FormCell's control.
Parameters:
| Name | Type | Description |
|---|---|---|
| isEnabled | boolean | true enables and false disables. |
Returns: Promise<any>
Deprecated¶
- use setEnabled(isEnabled: boolean)
Implementation of IFormCellProxy.setEnable
setEnabled¶
▸ setEnabled(isEnabled: boolean): Promise<any>
Sets the Enabled property of the FormCell's control.
Implementation of IFormCellProxy.setEnabled
Parameters:
| Name | Type | Description |
|---|---|---|
| isEnabled | boolean | true enables and false disables. |
Returns: Promise<any>
setFocus¶
▸ setFocus(keyboardVisibility: string): void
Set focus to the formcell (support Title Formcell / SimpleProperty Formcell / Note Formcell)
Implementation of IFormCellProxy.setFocus
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>
Sets the HelperText property of the FormCell's control.
Implementation of IFormCellProxy.setHelperText
Parameters:
| Name | Type | Description |
|---|---|---|
| helperText | string | value to set. |
Returns: Promise<any>
setRequiredIndicator¶
▸ setRequiredIndicator(indicator: string | Boolean): Promise<any>
Sets the RequiredIndicator property of the FormCell's control.
Can be either Boolean or a Character.
Defaults to an asterisk * if a string longer than one character is passed in.
Implementation of IFormCellProxy.setRequiredIndicator
Parameters:
| Name | Type | Description |
|---|---|---|
| indicator | string | Boolean | value to set. |
Returns: Promise<any>
setRequiredIndicatorStyle¶
▸ setRequiredIndicatorStyle(requiredIndicatorStyle: string): Promise<any>
Sets the Styles.RequiredIndicator property of the FormCell's control.
Implementation of IFormCellProxy.setRequiredIndicatorStyle
Parameters:
| Name | Type |
|---|---|
| requiredIndicatorStyle | string |
Returns: Promise<any>
setTargetSpecifier¶
▸ setTargetSpecifier(specifier: IFormCellTargetProxy, redraw?: boolean): Promise<any>
Set the target specifier for this FormCell control
Implementation of IFormCellProxy.setTargetSpecifier
Parameters:
| Name | Type | Description |
|---|---|---|
| specifier | IFormCellTargetProxy | specifier for the FormCell control |
| redraw? | boolean | whether to redraw formcell |
Returns: Promise<any>