Interface: IFormCellProxy¶
A designer-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.
In addition it provides access to the IControlProxy interface.
Hierarchy¶
-
IFormCellProxy
- IDatePickerFormCellProxy
- IMultiSorterFormCellProxy
- INoteFormCellProxy
- IInlineSignatureCaptureFormCellProxy
- ISignatureCaptureFormCellProxy
- IAttachmentFormCellProxy
- IButtonFormCellProxy
- ITitleFormCellProxy
- IExtensionFormCellProxy
- ISimplePropertyFormCellProxy
- ISegmentedFormCellProxy
- IListPickerFormCellProxy
- IAINoticeFormCellProxy
- IAIFeedbackFormCellProxy
- ILabelFormCellProxy
- IStepperFormCellProxy
Summary¶
Properties¶
Class Properties¶
Inherited Properties¶
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¶
- applyValidation
- base64StringToBinary
- binaryToBase64String
- callFunction
- clearValidation
- clearValidationOnValueChange
- convertFilterCriteriaArrayToJSONString
- convertJSONStringToFilterCriteriaArray
- count
- create
- createFilterCriteria
- createLinkSpecifierProxy
- 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
- getIconTextImage
- getLanguage
- getLogger
- getMobileServiceAppId
- getMobileServiceEndpointUrl
- getName
- getODataCacheImagePath
- getODataProvider
- getPageDefinition
- getPageProxy
- getPasscodeSource
- getPendingDownload
- getReadLink
- getRegion
- getRegions
- getSAPPassportHeaderValue
- getSupportedLanguages
- getTheme
- getType
- getUseInAppCamera
- getValue
- getVersionInfo
- initializeLogger
- isAppInMultiUserMode
- isContainer
- isCrashReportingEnabled
- isCurrentCrashConsentAllowed
- isCurrentPage
- isDemoMode
- isDeviceCompliant
- isMediaLocal
- localizeText
- read
- redraw
- sendMobileServiceRequest
- sendRequest
- setApplicationIconBadgeNumber
- setDebugSettings
- setEditable
- setLanguage
- setRegion
- setStyle
- setTheme
- setUseInAppCamera
- setValidationProperty
- setValue
- setVisible
- showActivityIndicator
- showCrashConsentDialog
- updateProgressBanner
Properties¶
searchString¶
▸ searchString: string
Returns the user provided search string for a ListPicker FormCell
visible¶
▸ visible: boolean
Property for viewing and setting the current visible state of the control.
Methods¶
clearFocus¶
▸ clearFocus(): void
Clear focus and close keyboard
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
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): DataQueryBuilder
Factory method to construct an instance of DataQueryBuilder
Parameters:
| Name | Type | Description |
|---|---|---|
| query | string | the query string |
Returns: DataQueryBuilder
getCaption¶
▸ getCaption(): string
Returns the Caption property value defined for the control.
Overrides IControlProxy.getCaption
Returns: string
getCollection¶
▸ getCollection(): object[]
Get collection of ListPicker Formcell, SegmentedControl Formcell, and Filter Formcell based on the DisplayValue and ReturnValue
Returns: object[]
getEditable¶
▸ getEditable(): boolean
Returns the Editable property value defined for the control.
Returns: boolean
getEnable()¶
▸ getEnable(): boolean
Returns the Enabled property value defined for the control.
Returns: boolean
Deprecated¶
- use getEnabled()
getEnabled¶
▸ getEnabled(): boolean
Returns the Enabled property value defined for the control.
Returns: boolean
getHelperText¶
▸ getHelperText(): string
Returns the HelperText property value defined for the control.
Returns: string
getRequiredIndicator¶
▸ getRequiredIndicator(): string
Returns the RequiredIndicator property value defined for the FormCell's control. Returns a String.
Returns: string
getRequiredIndicatorStyle¶
▸ getRequiredIndicatorStyle(): string
Returns the Styles.RequiredIndicator property value defined for the FormCell's control.
Returns: string
getTargetSpecifier¶
▸ getTargetSpecifier(): IFormCellTargetProxy
Gets target specifier for this FormCell control
Returns: IFormCellTargetProxy
getValidation¶
▸ getValidation(): IFormCellValidationProxy
Returns the FormCellValidationProxy for the control
Returns: IFormCellValidationProxy
getVisible¶
▸ getVisible(): boolean
Gets the control's visible state.
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
Returns: Promise<any>
setCaption¶
▸ setCaption(caption: string): Promise<any>
Sets the Caption property of the FormCell's control.
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.
Overrides IControlProxy.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)
setEnabled¶
▸ setEnabled(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>
setFocus¶
▸ setFocus(keyboardVisibility: string): void
Set focus to the formcell (support Title Formcell / SimpleProperty Formcell / Note Formcell)
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.
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.
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.
Parameters:
| Name | Type |
|---|---|
| requiredIndicatorStyle | string |
Returns: Promise<any>
setTargetSpecifier¶
▸ setTargetSpecifier(target: IFormCellTargetProxy, redraw?: boolean): Promise<any>
Set the target specifier for this FormCell control.
Parameters:
| Name | Type | Description |
|---|---|---|
| target | IFormCellTargetProxy | |
| redraw? | boolean | whether to redraw formcell |
Returns: Promise<any>
Throws¶
if target is incomplete