Skip to content

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

Implemented by

Summary

Properties

Class Properties

Inherited Properties

Methods

Class Methods

Inherited Methods

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

dataQueryBuilder

dataQueryBuilder(query: string): DataQueryBuilder

Factory method to construct an instance of DataQueryBuilder

Parameters:

Name Type
query string

Returns: DataQueryBuilder


getCaption

getCaption(): string

Overrides IControlProxy.getCaption

Returns the Caption property value defined for the control.

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


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


getTargetSpecifier

getTargetSpecifier(): IFormCellTargetProxy

Gets the target specifier or undefined

Returns: IFormCellTargetProxy


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 will not be triggered when resetting the control

Returns: Promise‹any›


setCaption

setCaption(caption: string): void

Sets the Caption property of the FormCell's control.

Parameters:

Name Type Description
caption string value to set.

Returns: void


setEditable

setEditable(isEditable: boolean): void

Overrides IControlProxy.setEditable

Sets the Editable property of the FormCell's control.

Parameters:

Name Type Description
isEditable boolean true if this form cell is editable. False otherwise.

Returns: void


setEnable

setEnable(isEnabled: boolean): void

Sets the Enabled property of the FormCell's control.

Parameters:

Name Type Description
isEnabled boolean true enables and false disables.

Returns: void


setEnabled

setEnabled(isEnabled: boolean): void

Sets the Enabled property of the FormCell's control.

Parameters:

Name Type Description
isEnabled boolean true enables and false disables.

Returns: void


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): void

Sets the HelperText property of the FormCell's control.

Parameters:

Name Type Description
helperText string value to set.

Returns: void


setTargetSpecifier

setTargetSpecifier(target: IFormCellTargetProxy, redraw?: boolean): Promise‹any›

Sets the target specifier and redraws the formcell

throws {Error} if target is incomplete

Parameters:

Name Type Description
target IFormCellTargetProxy -
redraw? boolean whether to redraw formcell

Returns: Promise‹any›