ListMetadata type
Important
The finance and operations (Dynamics 365) mobile app and platform have been deprecated. For more information, see Removed or deprecated platform features.
Metadata for list control.
Hierarchy
ContainerControlMetadata
└─ ListMetadata
Index
Properties
- BoundEntity
- BoundField
- Children
- Description
- DetailsPageAppId
- DetailsPageId
- Editable
- EmptyListMessage
- ExtType
- HelpText
- Hidden
- HideEmptyListMessage
- HideSearchBar
- Id
- InfiniteScroll
- InfiniteScrollPageSize
- Label
- ListStyle
- MultiSelect
- Name
- NonEntityProjection
- Order
- Type
Methods
Events
Properties
BoundEntity
BoundEntity: string (optional)
The entity to which the control is bound.
Inherited from ControlMetadata.BoundEntity
BoundField
BoundField: string (optional)
Inherited from ControlMetadata.BoundField
Children
Children: ControlMetadata [ ] (optional)
List of metadata for controls that will appear in each row of the list.
Description
Description: string (optional)
Description of the control.
Inherited from ControlMetadata.Description
DetailsPageAppId
DetailsPageAppId: string (optional)
App ID of the page that each row in the list will navigate to.
DetailsPageId
DetailsPageId: string (optional)
The ID of the page to which each row will navigate.
Editable
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
EmptyListMessage
EmptyListMessage: string (optional)
If set, overrides the default message for empty lists.
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
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
HideEmptyListMessage
HideEmptyListMessage: boolean (optional)
If true, the empty list message will be hidden.
HideSearchBar
HideSearchBar: boolean (optional)
If true, the search bar will be hidden.
Id
Id: string (optional)
Identification string for a control.
Inherited from ControlMetadata.Id
InfiniteScroll
InfiniteScroll: boolean (optional)
If set to true then the list will allow infinite scroll.
InfiniteScrollPageSize
InfiniteScrollPageSize: number (optional)
Number of rows to load initially and the number of rows to load after the user reaches the end of the currently displayed rows.
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
ListStyle
ListStyle: string (optional)
Dictates the list template type. Options:
- "Simple": simple style
- "Card": card style
MultiSelect
MultiSelect: boolean (optional)
If true, then the list will be a multi-select list.
Name
Name: string (optional)
Name of a control.
Inherited from ControlMetadata.Name
NonEntityProjection
NonEntityProjection: boolean (optional)
Order
Order: number (optional)
Number indicating the order in which a control will appear on a page.
Inherited from ControlMetadata.Order
Type
Type: ControlType (optional)
String indicating the control type.
Inherited from ControlMetadata.Type
Methods
navigationHandler
Optional
navigationHandler(row: Row): Promise <any> | NavigationArgs
A function that determines the navigation for a given row.
Parameters
Name | Type | Description |
---|---|---|
row | Row | row to get navigation handler for. |
Returns Promise <any> | NavigationArgs
Events
OnNavigate
OnNavigate: function(navigation: NavigationArgs): any (optional)
An event that is triggered when a pagelink control is selected.
OnRowSelect
OnRowSelect: function(row: Row): void (optional)
An event that is triggered when a row is selected.