title | description | author | ms.author | ms.topic | ms.date | ms.reviewer | audience | ms.search.region |
---|---|---|---|---|---|---|---|---|
LookupMetadata type |
Learn about the lookup metadata type, which includes the BoundEntity, BoundField, Description, DisplayField, DisplayKey, and other properties. |
jasongre |
jasongre |
article |
05/24/2022 |
johnmichalak |
Developer |
Global |
[!include banner] [!include mobile app deprecated]
Lookup metadata type.
InputControlMetadata
└─ LookupMetadata
- BoundEntity
- BoundField
- Description
- DisplayField
- DisplayKey
- Editable
- ExtType
- FilterContext
- HelpText
- Hidden
- Id
- Label
- LookupEntity
- LookupPage
- LookupPageId
- Mandatory
- MultiSelect
- Name
- NumSequence
- Order
- ReferenceAppId
- ShowLookupPage
- Type
- ValueField
- ValueKey
BoundEntity: string (optional)
The entity to which the control is bound.
Inherited from ControlMetadata.BoundEntity
BoundField: string (optional)
Inherited from ControlMetadata.BoundField
Description: string (optional)
Description of the control.
Inherited from ControlMetadata.Description
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: string (optional)
Editable: boolean (optional)
Boolean indicating if the control is editable. False when either the control or its parent is not editable. True when both the control and its parent are editable. True when either the control or its parent is editable and the other is undefined. Undefined if both the control's edit-ability and its parent's edit-ability is undefined.
Inherited from ControlMetadata.Editable
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: DataFilter (optional)
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: string (optional)
Identification string for a control.
Inherited from ControlMetadata.Id
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: any (optional)
The entity that is being looked up in the lookup.
LookupPage: string (optional)
LookupPageId: string (optional)
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: boolean (optional)
If true, lookup will be configured as a multi-select.
Name: string (optional)
Name of a control.
Inherited from ControlMetadata.Name
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. Example:
// hide number sequence reference page from users
metadataService.hideNavigation('numSeqReferencePage');
// parameters to be passed to 'numSequence' flag in configureControl
var configParam = {
referencePageName: 'numSeqReferencePage',
dataType: 'HcmPersonnelNumberId'
};
// setup 'PersonnelNumber' control as number sequence in the task 'add-worker'
metadataService.configureControl('add-worker', 'PersonnelNumber', { numSequence: configParam });
Inherited from InputControlMetadata.NumSequence
Order: number (optional)
Number indicating the order in which a control will appear on a page.
Inherited from ControlMetadata.Order
ReferenceAppId: string (optional)
ShowLookupPage: boolean (optional)
Type: ControlType (optional)
String indicating the control type.
Inherited from ControlMetadata.Type
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: string (optional)
OnOptionSelected: function(lookup: any, lookupEntityData: any): void (optional)
An event that is triggered by an option being selected.
OnValueChanged: function(value: any): void (optional)
An event that is triggered by a value being changed.
[!INCLUDEfooter-include]