List Type

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.

Hierarchy

ContainerControl
   └─ List

Index

Properties

Methods

Events

Properties

$accessibility

$accessibility: any

DefaultSearchColumn

DefaultSearchColumn: string

container

container: boolean

True if the control is a container.

Inherited from ContainerControl.container

Overrides Control.container

emptyListMessage

emptyListMessage: string

Settable property to override default empty list message.

enableMultiSelect

enableMultiSelect: boolean

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

hideEmptyListMessage

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

imageFields: any [ ]

performingRemoteSearch

performingRemoteSearch: boolean

searchQuery

searchQuery: [value: string]: any

Methods

allowsNavigation

allowsNavigation(): boolean

Returns boolean

applyDesign

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

Parameters

Name Type Description
IDesign ListDesign object containing design properties as keys

Returns void

applySearch

applySearch(): void

Returns void

canPerformRemoteSearch

canPerformRemoteSearch(): boolean

Returns boolean

clearSearch

clearSearch(): void

Returns void

dataContext

dataContext(): any

Inherited from Control.dataContext

Returns any

getColumnLabel

getColumnLabel(id: string): string

Parameters

Name Type Description
id string

Returns string

getControl

getControl(controlName: string): Control

Given the name of a control, returns the control instance.

Inherited from ContainerControl.getControl

Parameters

Name Type Description
controlName string control name

Returns Control

getControlById

getControlById(id: string): Control

Given the ID of a control, returns the control instance.

Inherited from ContainerControl.getControlById

Parameters

Name Type Description
id string control ID

Returns Control

getControlMetadata

getControlMetadata(controlName: string): Control

Parameters

Name Type Description
controlName string

Returns Control

getControlMetadataById

getControlMetadataById(id: string): Control

Parameters

Name Type Description
id string

Returns Control

getData

getData(): any [ ]

Returns any [ ]

getDesign

getDesign(): Design

Returns the design object of this control.

Inherited from Control.getDesign

Returns Design

getListData

getListData(): any

Returns any

getRenderedRows

getRenderedRows(): Row [ ]

Returns Row [ ]

getRowNavigation

getRowNavigation(row: Row): Promise <any> | any

Parameters

Name Type Description
row Row

Returns Promise <any> | any

getRowSelectionCount

getRowSelectionCount(): number

Returns number

getRowSelections

getRowSelections(): string [ ]

Returns string [ ]

getRowTracking

getRowTracking(row: any, index: string): string

Parameters

Name Type Description
row any
index string

Returns string

getSearchColumn

getSearchColumn(): string

Returns string

getSearchColumnLabel

getSearchColumnLabel(): string

Returns string

getSearchableColumns

getSearchableColumns(): any [ ]

Returns any [ ]

hideSearchBar

hideSearchBar(): boolean

Returns boolean

isEditable

isEditable(): boolean

Boolean indicating if the control is editable. Returns false when either the control or it's parent is not editable. Returns true when both the control and it's parent are editable. Returns true when either the control or it's parent is editable and the other is undefined. Returns undefined if both the control's edit-ability and it's parent's edit-ability is undefined.

Inherited from Control.isEditable

Returns boolean

loadMetaData

loadMetaData(): void

Returns void

loadMore

loadMore(): void

Returns void

metadata

metadata(): ListMetadata

Returns the metadata object of this control.

Overrides ContainerControl.metadata

Returns ListMetadata

parent

parent(): Control | Page

Returns the parent (control or page) of this control.

Inherited from Control.parent

Returns Control | Page

performRemoteSearch

performRemoteSearch(): void

Returns void

root

root(): Page

Returns the root form instance (page) of this control.

Inherited from Control.root

Returns Page

selectSearchColumn

selectSearchColumn(column: string): void

Parameters

Name Type Description
column string

Returns void

setRowSections

setRowSections(selections: string [ ]): void

Parameters

Name Type Description
selections string [ ]

Returns void

Events

onRowCreate

onRowCreate: EventHook <Row>

onRowSelect

onRowSelect: EventHook <Row>