title | description | author | ms.author | ms.topic | ms.date | ms.reviewer | audience | ms.search.region |
---|---|---|---|---|---|---|---|---|
List type |
Learn about the list control type, which contains any number of rows and contains the DefaultSearchColumn, container, emptyListMessage, and other properties. |
jasongre |
jasongre |
article |
05/24/2022 |
johnmichalak |
Developer |
Global |
[!include banner] [!include mobile app deprecated]
List control type. A list is a control that contains any numbers of rows. Each row follows a template for the layout of any number of controls. Lists come in two styles: simple and card.
ContainerControl
└─ List
- $accessibility
- DefaultSearchColumn
- container
- emptyListMessage
- enableMultiSelect
- generic
- getDataSource
- hidden
- hideEmptyListMessage
- imageFields
- performingRemoteSearch
- searchQuery
- allowsNavigation
- applyDesign
- applySearch
- canPerformRemoteSearch
- clearSearch
- dataContext
- getColumnLabel
- getControl
- getControlById
- getControlMetadata
- getControlMetadataById
- getData
- getDesign
- getListData
- getRenderedRows
- getRowNavigation
- getRowSelectionCount
- getRowSelections
- getRowTracking
- getSearchColumn
- getSearchColumnLabel
- getSearchableColumns
- hideSearchBar
- isEditable
- loadMetaData
- loadMore
- metadata
- parent
- performRemoteSearch
- root
- selectSearchColumn
- setRowSections
$accessibility: any
DefaultSearchColumn: string
container: boolean
True if the control is a container.
Inherited from ContainerControl.container
emptyListMessage: string
Settable property to override default empty list message.
enableMultiSelect: boolean
generic: boolean (optional)
getDataSource: function(): any
Inherited from Control.getDataSource
hidden
hidden: boolean
True if the control is hidden.
hideEmptyListMessage: boolean
If true, no message is shown if the list is empty. To set this property, update the corresponding metadata property via configureControl.
imageFields: any [ ]
performingRemoteSearch: boolean
searchQuery: [value: string]: any
allowsNavigation(): boolean
applyDesign(IDesign: ListDesign): 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 | ListDesign | object containing design properties as keys |
applySearch(): void
canPerformRemoteSearch(): boolean
clearSearch(): void
dataContext(): any
Inherited from Control.dataContext
getColumnLabel(id: string): string
Name | Type | Description |
---|---|---|
id | string |
getControl(controlName: string): Control
Given the name of a control, returns the control instance.
Inherited from ContainerControl.getControl
Name | Type | Description |
---|---|---|
controlName | string | control name |
Returns Control
getControlById(id: string): Control
Given the ID of a control, returns the control instance.
Inherited from ContainerControl.getControlById
Name | Type | Description |
---|---|---|
id | string | control ID |
Returns Control
getControlMetadata(controlName: string): Control
Name | Type | Description |
---|---|---|
controlName | string |
Returns Control
getControlMetadataById(id: string): Control
Name | Type | Description |
---|---|---|
id | string |
Returns Control
getData(): any [ ]
getDesign(): Design
Returns the design object of this control.
Returns Design
getListData(): any
getRenderedRows(): Row [ ]
Returns Row [ ]
getRowNavigation(row: Row): Promise <any> | any
Name | Type | Description |
---|---|---|
row | Row |
getRowSelectionCount(): number
getRowSelections(): string [ ]
getRowTracking(row: any, index: string): string
Name | Type | Description |
---|---|---|
row | any | |
index | string |
getSearchColumn(): string
getSearchColumnLabel(): string
getSearchableColumns(): any [ ]
hideSearchBar(): boolean
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
loadMetaData(): void
loadMore(): void
metadata(): ListMetadata
Returns the metadata object of this control.
Overrides ContainerControl.metadata
Returns ListMetadata
Returns the parent (control or page) of this control.
performRemoteSearch(): void
root(): Page
Returns the root form instance (page) of this control.
Returns Page
selectSearchColumn(column: string): void
Name | Type | Description |
---|---|---|
column | string |
setRowSections(selections: string [ ]): void
Name | Type | Description |
---|---|---|
selections | string [ ] |
[!INCLUDEfooter-include]