Field

Represents the run-time instance of a field.

Index

Types

Types

Field

Hierarchy

InputControl
   └─ Field

Properties

Name Signature Description
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

Name Signature Description
applyDesign applyDesign(IDesign: FieldDesign): void Applies given design to the design on the control.
Overrides Control.applyDesign
dataContext dataContext(): any Inherited from Control.dataContext
getDesign getDesign(): Design Returns the design object of this control.
Inherited from Control.getDesign
getEditableFormattedValue getEditableFormattedValue(): string | number | Date Gets a formatted decimal string value of an editable field control.
getEditableValue getEditableValue(): string | number | Date Gets the value for an editable field control.
getEntityRef getEntityRef(): any Gets value of entityRef binding to control.
getFormattedValue getFormattedValue(): string Gets a formatted decimal string value.
getRefLink getRefLink(): NavigationArgs Gets the navigation object for a reference link.
getValue getValue(): any Gets the value for a field control.
hasRefLink hasRefLink(): boolean Returns true if the field has a refLink, otherwise false.
hasUnWrapText hasUnWrapText(): boolean Gets wrap text property of control.
isEditable isEditable(): boolean Boolean indicating if the control is editable.
Inherited from Control.isEditable
metadata metadata(): FieldMetadata Returns the metadata object of this control.
Overrides InputControl.metadata
parent parent(): Control | Page Returns the parent (control or page) of this control.
Inherited from Control.parent
root root(): Page Returns the root form instance (page) of this control.
Inherited from Control.root
setEditableValue setEditableValue(value: string | number | Date): void Sets the value for an editable field control.

Events

Name Signature Description
onDataChanged onDataChanged: EventHook <null>
An event that is triggered when the input control's data changes.
Inherited from InputControl.onDataChanged

FieldDesign

Hierarchy

InputControlDesign
   └─ FieldDesign

Properties

Name Signature Description
alignItems alignItems: string (optional)
This property is an alias for the CSS property "align-items".
Inherited from Design.alignItems
alignSelf alignSelf: string (optional)
Inherited from Design.alignSelf
bindings bindings: any (optional)
Inherited from Design.bindings
border border: "none" | "solid" | "left" | "right" | "top" | "bottom" (optional)
The border behavior of a control. This property will not be inherited by the children.
Inherited from Design.border
color color: string (optional)
The foreground color of the container.
Inherited from Design.color
flexFlow flexFlow: string (optional)
Specifying this property makes the component a flex container component.
Inherited from Design.flexFlow
flexSize flexSize: string (optional)
One number or two numbers written as a string. E.g. "(size to grow) [(size-to-shrink)]" to accommodate available space in the immediate flex container.
Inherited from Design.flexSize
fontSize fontSize: "medium" | "xx-small" | "x-small" | "small" | "large" | "x-large" | "xx-large" (optional)
The proportional text size
Inherited from Design.fontSize
fontWeight fontWeight: "normal" | "bold" (optional)
Normal or bold text.
Inherited from Design.fontWeight
justifyItems justifyItems: "flex-start" | "flex-end" | "center" | "space-between" (optional)
This property is an alias for the CSS property "justify-content".
Inherited from Design.justifyItems
label label: string (optional)
Inherited from Design.label
labelPosition labelPosition: "stacked" | "hidden" | "inline" (optional)
Determines how a label is positioned, if at all. By default, labelPosition is set to stacked.
Inherited from Design.labelPosition
name name: string (optional)
Inherited from Design.name
padding padding: "none" | "small" | "std" (optional)
Allows specifying the component's padding behavior.
Inherited from Design.padding
type type: ControlType (optional)
The type of the control as a string.
Inherited from Design.type

FieldMetadata

Hierarchy

InputControlMetadata
   └─ FieldMetadata

Properties

Name Signature Description
BoundEntity BoundEntity: string (optional)
The entity to which the control is bound.
Inherited from ControlMetadata.BoundEntity
BoundField BoundField: string (optional)
Inherited from ControlMetadata.BoundField
DecimalPlaces DecimalPlaces: number (optional)
The number of decimals that appear on a field of type "Real".
Description Description: string (optional)
Description of the control.
Inherited from ControlMetadata.Description
Editable Editable: boolean (optional)
Boolean indicating if the control is editable.
Inherited from ControlMetadata.Editable
ExtType ExtType: ControlType (optional)
The extended control type. E.g. a control of type Input might have an extended type of Barcode.
Inherited from ControlMetadata.ExtType
Formatting Formatting: any (optional)
Formats a field of type "DateTime" or "Date".
HelpText HelpText: string (optional)
The keyboard shortcut for a command. E.g. "(Shift+F5)"
Inherited from ControlMetadata.HelpText
Hidden Hidden: boolean (optional)
Boolean indicating if the control is hidden or not.
Inherited from ControlMetadata.Hidden
Id Id: string (optional)
Identification string for a control.
Inherited from ControlMetadata.Id
Label Label: string (optional)
Label for a control. E.g. a control representing a person's first name might have a label "First Name".
Inherited from ControlMetadata.Label
LinkType LinkType: "Telephone" | "Email" | "Url" (optional)
Assigning the link type of a field allows for the appropriate mobile application to be opened when the link is selected.
Mandatory Mandatory: boolean (optional)
If set to true then input for the control is required for the task to be completed. Mandatory controls will have a red outline.
Inherited from InputControlMetadata.Mandatory
Name Name: string (optional)
Name of a control.
Inherited from ControlMetadata.Name
NumSequence NumSequence: NumberSequenceConfig (optional)
Used for auto detecting and changing visibility of the number sequence controls in the task or page, based on AX number sequence configuration, through extended business logic.
Inherited from InputControlMetadata.NumSequence
Order Order: number (optional)
Number indicating the order in which a control will appear on a page.
Inherited from ControlMetadata.Order
ReferenceAppId ReferenceAppId: string (optional)
The ID of the app that the field control lives in.
ReferencePageId ReferencePageId: string (optional)
The ID of the page that the field control lives in.
Style Style: string (optional)
Styles a field of type "DateTime" or "Date".
Type Type: ControlType (optional)
String indicating the control type.
Inherited from ControlMetadata.Type
UnWrapText UnWrapText: boolean (optional)
False by default -- text of the page will be wrapped.
WrapText WrapText: boolean (optional)
If true then the text of the field control will wrap to the next line.