Skip to content

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

Implements

Summary

Constructors

Properties

Class Properties

Inherited Properties

Accessors

Class Accessors

Inherited Accessors

Methods

Class Methods

Inherited Methods

Constructors

constructor

+ new FormCellControlProxy(context: IContext): FormCellControlProxy

Overrides ControlProxy.constructor

Parameters:

Name Type
context IContext

Returns: FormCellControlProxy

Properties

Accessors

searchString

get searchString(): string

Get the user provided search string for a ListPicker FormCell

Returns: string


visible

get visible(): boolean

Property for viewing the current visible state of the control

Returns: boolean

set visible(visible: boolean): void

Property for setting the current visible state of the control

Parameters:

Name Type
visible boolean

Returns: void

Methods

createAttachmentEntry

createAttachmentEntry(attachmentPath: string, entitySet: string, property: string, readLink: string, service: string, encodeURI: boolean): any

Create an object for attachment entry Note: This function is for iOS & Android only

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

Factory method to construct an instance of DataQueryBuilder

Parameters:

Name Type Default Description
query string undefined the query string

Returns: DataQueryBuilder


getCaption

getCaption(): string

Implementation of IFormCellProxy

Overrides ControlProxy.getCaption

Returns the Caption property value defined for the control.

Returns: string


getCollection

getCollection(): object[]

Implementation of IFormCellProxy

Get collection of ListPicker Formcell, SegmentedControl Formcell and Filter Formcell based on the DisplayValue and ReturnValue

Returns: object[]


getEditable

getEditable(): boolean

Implementation of IFormCellProxy

Returns the Editable property value defined for the control.

Returns: boolean


getEnable

getEnable(): boolean

Implementation of IFormCellProxy

Returns the Enabled property value defined for the control.

deprecated - use getEnabled()

Returns: boolean


getEnabled

getEnabled(): boolean

Implementation of IFormCellProxy

Returns the Enabled property value defined for the control.

Returns: boolean


getHelperText

getHelperText(): string

Implementation of IFormCellProxy

Returns the HelperText property value defined for the control. @return {string}

Returns: string


getTargetSpecifier

getTargetSpecifier(): IFormCellTargetProxy

Implementation of IFormCellProxy

Get target specifier for this FormCell control

Returns: IFormCellTargetProxy


getVisible

getVisible(): boolean

Implementation of IFormCellProxy

Gets the control's visible state.

Returns: boolean

returns true if the control is visible otherwise false.


reset

reset(): Promise‹any›

Implementation of IFormCellProxy

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

Implementation of IFormCellProxy

Sets the Caption property of the FormCell's control.

Parameters:

Name Type Description
caption string value to set.

Returns: void


setEditable

setEditable(isEditable: boolean): any

Implementation of IFormCellProxy

Overrides ControlProxy.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: any


setEnable

setEnable(isEnabled: boolean): void

Implementation of IFormCellProxy

Sets the Enabled property of the FormCell's control.

deprecated - use setEnabled(isEnabled: boolean)

Parameters:

Name Type Description
isEnabled boolean true enables and false disables.

Returns: void


setEnabled

setEnabled(isEnabled: boolean): void

Implementation of IFormCellProxy

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

Implementation of IFormCellProxy

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

Implementation of IFormCellProxy

Sets the HelperText property of the FormCell's control.

Parameters:

Name Type Description
helperText string value to set.

Returns: void


setTargetSpecifier

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

Implementation of IFormCellProxy

Set the FormCell control

Parameters:

Name Type Description
specifier IFormCellTargetProxy specifier for the FormCell control
redraw? boolean whether to redraw formcell

Returns: Promise‹any›