Interface: IFormCellProxy¶

Hierarchy¶

Implemented by¶

Summary¶

Properties¶

Class Properties¶

Inherited Properties¶

Methods¶

Class Methods¶

Inherited Methods¶

Properties¶

searchString¶

• searchString: string

visible¶

• visible: boolean

Methods¶

clearFocus¶

▸ clearFocus(): void

Returns: void

createAttachmentEntry¶

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

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

Parameters:

Name	Type
`query`	string

Returns: DataQueryBuilder

getCaption¶

▸ getCaption(): string

Overrides IControlProxy.getCaption

Returns: string

getCollection¶

▸ getCollection(): object[]

Returns: object[]

getEditable¶

▸ getEditable(): boolean

Returns: boolean

getEnable¶

▸ getEnable(): boolean

Returns: boolean

getEnabled¶

▸ getEnabled(): boolean

Returns: boolean

getHelperText¶

▸ getHelperText(): string

Returns: string

getRequiredIndicator¶

▸ getRequiredIndicator(): string

Returns: string

getRequiredIndicatorStyle¶

▸ getRequiredIndicatorStyle(): string

Returns: string

getTargetSpecifier¶

▸ getTargetSpecifier(): IFormCellTargetProxy

Returns: IFormCellTargetProxy

getValidation¶

▸ getValidation(): IFormCellValidationProxy

Returns: IFormCellValidationProxy

getVisible¶

▸ getVisible(): boolean

Returns: boolean

returns true if the control is visible otherwise false.

reset¶

▸ reset(): Promise‹any›

Returns: Promise‹any›

setCaption¶

▸ setCaption(caption: string): Promise‹any›

Parameters:

Name	Type	Description
`caption`	string	value to set.

Returns: Promise‹any›

setEditable¶

▸ setEditable(isEditable: boolean): Promise‹any›

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›

Parameters:

Name	Type	Description
`isEnabled`	boolean	true enables and false disables.

Returns: Promise‹any›

setEnabled¶

▸ setEnabled(isEnabled: boolean): Promise‹any›

Parameters:

Name	Type	Description
`isEnabled`	boolean	true enables and false disables.

Returns: Promise‹any›

setFocus¶

▸ setFocus(keyboardVisibility: string): void

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›

Parameters:

Name	Type	Description
`helperText`	string	value to set.

Returns: Promise‹any›

setRequiredIndicator¶

▸ setRequiredIndicator(indicator: string): Promise‹any›

Parameters:

Name	Type	Description
`indicator`	string	value to set.

Returns: Promise‹any›

setRequiredIndicatorStyle¶

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

Parameters:

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

Returns: Promise‹any›

setTargetSpecifier¶

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

Parameters:

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

Returns: Promise‹any›