Control module
Important
The finance and operations (Dynamics 365) mobile app and platform are no longer supported. The platform components supporting the mobile app will be removed in a future update. The mobile app has also been removed from app stores. Previously installed instances of the app will continue to work. For more information, see Removed or deprecated platform features.
Controls are what make up the content of a page.
Index
Types
Type aliases
Types
Control
Hierarchy
Control
└─ PageLink
└─ ContainerControl
└─ InputControl
└─ Image
Properties
| Name | Signature | Description |
|---|---|---|
| container | container: boolean (optional) |
True if the control is a container. |
| generic | generic: boolean (optional) |
|
| getDataSource | getDataSource: function(): any |
|
| hidden | hidden: boolean |
True if the control is hidden. |
Methods
| Name | Signature | Description |
|---|---|---|
| applyDesign | applyDesign(design: Design): void | Applies given design to the design on the control. |
| dataContext | dataContext(): any | |
| getDesign | getDesign(): Design | Returns the design object of this control. |
| isEditable | isEditable(): boolean | Boolean indicating if the control is editable. |
| metadata | metadata(): ControlMetadata | Returns the metadata object of this control. |
| parent | parent(): Control | Page | Returns the parent (control or page) of this control. |
| root | root(): Page | Returns the root form instance (page) of this control. |
ControlMetadata
Hierarchy
ControlMetadata
└─ PageLinkMetadata
└─ ContainerControlMetadata
└─ InputControlMetadata
└─ ImageMetadata
Properties
| Name | Signature | Description |
|---|---|---|
| BoundEntity | BoundEntity: string (optional) |
The entity to which the control is bound. |
| BoundField | BoundField: string (optional) |
|
| Description | Description: string (optional) |
Description of the control. |
| Editable | Editable: boolean (optional) |
Boolean indicating if the control is editable. |
| ExtType | ExtType: ControlType (optional) |
The extended control type. For example, a control of type Input might have an extended type of Barcode. |
| HelpText | HelpText: string (optional) |
The keyboard shortcut for a command. For example, "(Shift+F5)" |
| Hidden | Hidden: boolean (optional) |
Boolean indicating if the control is hidden or not. |
| Id | Id: string (optional) |
Identification string for a control. |
| Label | Label: string (optional) |
Label for a control. For example, a control representing a person's first name might have a label "First Name". |
| Name | Name: string (optional) |
Name of a control. |
| Order | Order: number (optional) |
Number indicating the order in which a control will appear on a page. |
| Type | Type: ControlType (optional) |
String indicating the control type. |
Type aliases
ControlType
ControlType: "FileUpload" | "Barcode" | "Input" | "MultilineInput" | "Navigation" | "Integer" | "Int64" | "Date" | "DateTime" | "ComboBox" | "Real" | "List" | "Lookup" | "MultiLookup" | "Navigation" | "Image" | "Group" | "Part" | "Calendar" | "HyperLink" | "Timer"
Controls must be assigned any of the types listed in ControlType.