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¶

clearFocus¶

▸ clearFocus(): void

Clear focus and close keyboard

Returns: void

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

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

getRequiredIndicator¶

▸ getRequiredIndicator(): string

Returns the RequiredIndicator property value defined for the FormCell's control. Can be either Boolean or 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 the target specifier or undefined

Returns: IFormCellTargetProxy

getValidation¶

▸ getValidation(): IFormCellValidationProxy

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

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›

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: 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›

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): 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 1 character is passed in.

Parameters:

Name	Type	Description
`indicator`	string	value to set.

Returns: Promise‹any›

setRequiredIndicatorStyle¶

▸ setRequiredIndicatorStyle(requiredIndicatorStyle: string): Promise‹any›

Sets the Styles.RequiredIndicator property value defined for the FormCell's control.

Parameters:

Name	Type	Description
`requiredIndicatorStyle`	string	Style's classname value to set.

Returns: Promise‹any›

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›