Field Type

Field control type.

Hierarchy

InputControl
   └─ Field

Index

Properties

Methods

Events

Properties

container

container: boolean (optional)

True if the control is a container.

Inherited from Control.container

generic

generic: boolean (optional)

Inherited from Control.generic

getDataSource

getDataSource: function(): any

Inherited from Control.getDataSource

hidden

hidden: boolean

True if the control is hidden.

Inherited from Control.hidden

Methods

applyDesign

applyDesign(IDesign: FieldDesign): void

Applies given design to the design on the control. If a design already exists, the prototype chain of the design will be preserved.

Overrides Control.applyDesign

Parameters

Name Type Description
IDesign FieldDesign object containing design properties as keys

Returns void

dataContext

dataContext(): any

Inherited from Control.dataContext

Returns any

getDesign

getDesign(): Design

Returns the design object of this control.

Inherited from Control.getDesign

Returns Design

getEditableFormattedValue

getEditableFormattedValue(): string | number | Date

Gets a formatted decimal string value of an editable field control.

Returns string | number | Date

getEditableValue

getEditableValue(): string | number | Date

Gets the value for an editable field control.

Returns string | number | Date

getEntityRef

getEntityRef(): any

Gets value of entityRef binding to control.

Returns any

value of entityRef binding to control

getFormattedValue

getFormattedValue(): string

Gets a formatted decimal string value.

Returns string

getRefLink(): NavigationArgs

Gets the navigation object for a reference link.

Returns NavigationArgs

getValue

getValue(): any

Gets the value for a field control.

Returns any

hasRefLink(): boolean

Returns true if the field has a refLink, otherwise false.

Returns boolean

hasUnWrapText

hasUnWrapText(): boolean

Gets wrap text property of control.

Returns boolean

isEditable

isEditable(): boolean

Boolean indicating if the control is editable. Returns false when either the control or it's parent is not editable. Returns true when both the control and it's parent are editable. Returns true when either the control or it's parent is editable and the other is undefined. Returns undefined if both the control's edit-ability and it's parent's edit-ability is undefined.

Inherited from Control.isEditable

Returns boolean

metadata

metadata(): FieldMetadata

Returns the metadata object of this control.

Overrides InputControl.metadata

Returns FieldMetadata

parent

parent(): Control | Page

Returns the parent (control or page) of this control.

Inherited from Control.parent

Returns Control | Page

root

root(): Page

Returns the root form instance (page) of this control.

Inherited from Control.root

Returns Page

setEditableValue

setEditableValue(value: string | number | Date): void

Sets the value for an editable field control.

Parameters

Name Type Description
value string | number | Date value

Returns void

Events

onDataChanged

onDataChanged: EventHook <null>

An event that is triggered when the input control's data changes.

Inherited from InputControl.onDataChanged