title | description | author | ms.author | ms.topic | ms.date | ms.reviewer | audience | ms.search.region |
---|---|---|---|---|---|---|---|---|
Field type |
Learn about the Field type, which includes the container, generic, getDataSource, and hidden properties and various methods. |
jasongre |
jasongre |
article |
05/24/2022 |
johnmichalak |
Developer |
Global |
[!include banner] [!include mobile app deprecated]
Field control type.
InputControl
└─ Field
- applyDesign
- dataContext
- getDesign
- getEditableFormattedValue
- getEditableValue
- getEntityRef
- getFormattedValue
- getRefLink
- getValue
- hasRefLink
- hasUnWrapText
- isEditable
- metadata
- parent
- root
- setEditableValue
container: boolean (optional)
True if the control is a container.
generic: boolean (optional)
getDataSource: function(): any
Inherited from Control.getDataSource
hidden
hidden: boolean
True if the control is hidden.
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
Name | Type | Description |
---|---|---|
IDesign | FieldDesign | object containing design properties as keys |
dataContext(): any
Inherited from Control.dataContext
getDesign(): Design
Returns the design object of this control.
Returns Design
getEditableFormattedValue(): string | number | Date
Gets a formatted decimal string value of an editable field control.
getEditableValue(): string | number | Date
Gets the value for an editable field control.
getEntityRef(): any
Gets value of entityRef binding to control.
value of entityRef binding to control
getFormattedValue(): string
Gets a formatted decimal string value.
getRefLink(): NavigationArgs
Gets the navigation object for a reference link.
Returns NavigationArgs
getValue(): any
Gets the value for a field control.
hasRefLink(): boolean
Returns true if the field has a refLink, otherwise false.
hasUnWrapText(): boolean
Gets wrap text property of control.
isEditable(): boolean
Boolean indicating if the control is editable. Returns false when either the control or its parent is not editable. Returns true when both the control and its parent are editable. Returns true when either the control or its parent is editable and the other is undefined. Returns undefined if both the control's edit-ability and its parent's edit-ability is undefined.
Inherited from Control.isEditable
metadata(): FieldMetadata
Returns the metadata object of this control.
Overrides InputControl.metadata
Returns FieldMetadata
Returns the parent (control or page) of this control.
root(): Page
Returns the root form instance (page) of this control.
Returns Page
setEditableValue(value: string | number | Date): void
Sets the value for an editable field control.
Name | Type | Description |
---|---|---|
value | string | number | Date | value |
onDataChanged: EventHook <null>
An event that is triggered when the input control's data changes.
Inherited from InputControl.onDataChanged
[!INCLUDEfooter-include]