Lookup 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.
A lookup is an input control that is used to select an input from a list of options. For example, a lookup could be used to lookup a customer when linking a customer to a new sales order.
Index
Types
Types
Lookup
Hierarchy
InputControl
└─ Lookup
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: LookupDesign): 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 |
| getDisplayValue | getDisplayValue(): string | |
| getLookupPage | getLookupPage(): Page | |
| getValue | getValue(): string | number | |
| isEditable | isEditable(): boolean | Boolean indicating if the control is editable. Inherited from Control.isEditable |
| metadata | metadata(): LookupMetadata | 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 |
| setEntityRef | setEntityRef(newValue: string | number): Promise <any> |
Events
| Name | Signature | Description |
|---|---|---|
| onDataChanged | onDataChanged: EventHook <null> |
An event that is triggered when the input control's data changes. Inherited from InputControl.onDataChanged |
LookupDesign
Hierarchy
InputControlDesign
└─ LookupDesign
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. For example, "(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 |
LookupMetadata
Hierarchy
InputControlMetadata
└─ LookupMetadata
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 |
| Description | Description: string (optional) |
Description of the control. Inherited from ControlMetadata.Description |
| DisplayField | DisplayField: string (optional) |
The name of a control on the page, whose value should be displayed to the user. Usually, this value is user-friendly user-readable text. |
| DisplayKey | DisplayKey: string (optional) |
|
| Editable | Editable: boolean (optional) |
Boolean indicating if the control is editable. Inherited from ControlMetadata.Editable |
| ExtType | ExtType: ControlType (optional) |
The extended control type. For example, a control of type Input might have an extended type of Barcode. Inherited from ControlMetadata.ExtType |
| FilterContext | FilterContext: DataFilter (optional) |
|
| HelpText | HelpText: string (optional) |
The keyboard shortcut for a command. For example, "(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. For example, a control representing a person's first name might have a label "First Name". Inherited from ControlMetadata.Label |
| LookupEntity | LookupEntity: any (optional) |
The entity that is being looked up in the lookup. |
| LookupPage | LookupPage: string (optional) |
|
| LookupPageId | LookupPageId: string (optional) |
|
| 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 |
| MultiSelect | MultiSelect: boolean (optional) |
If true, lookup will be configured as a multi-select. |
| 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) |
|
| ShowLookupPage | ShowLookupPage: boolean (optional) |
|
| Type | Type: ControlType (optional) |
String indicating the control type. Inherited from ControlMetadata.Type |
| ValueField | ValueField: string (optional) |
The name of a control on the page, whose value should be used when committing the data. Usually, this value is a unique key. |
| ValueKey | ValueKey: string (optional) |
Events
| Name | Signature | Description |
|---|---|---|
| OnOptionSelected | OnOptionSelected: function(lookup: any, lookupEntityData: any): void (optional) |
An event that is triggered by an option being selected. |
| OnValueChanged | OnValueChanged: function(value: any): void (optional) |
An event that is triggered by a value being changed. |