ListBoxModel
Interface representing the ListBox class.
Properties
actionFailureText String
Specifies the text to be displayed when a remote request fails.
Default: Error occurred in the request
allowDragAndDrop Boolean
Specifies whether to allow the list of items to be filtered as input is entered into the list box.
Default: false
allowFiltering Boolean
Specifies whether to allow the list of items to be filtered as input is entered into the search box.
Default: false
cssClass String
Specifies CSS classes to customize the appearance of the control.
Default: null
dataStore {:} DataStore String[]
Specifies a list of items that should be bound to the control either via a local object or a remote data source.
Default: []
enabled Boolean
Specifies whether the control is enabled or disabled, disabled will prevent user interaction.
Default: true
enableRtl Boolean
Specifies whether to render the control in right to left direction.
Default: false
enableState Boolean
Specifies whether to persist the state of the control between page loads.
- value
Default: false
fields ItemSettingsModel
Specifies the property mapping for the data source columns to the items in the list.
Default: { }
filterBarPlaceholder String
Specifies a placeholder for the filter search text box.
Default: null
filterType FilterType
Specifies the type of filter to be used when filter the list items.
Default: StartsWith
groupTemplate String Function
Specifies a template to customize the appearance of the grouping headers.
Default: null
height String Number
Specifies the height of the accordion in either pixels, number, or percentage.
Default: ""
ignoreAccent Boolean
Specifies whether to ignore diacritic characters when filtering the list items.
Default: false
ignoreCase Boolean
Specifies whether to ignore the case, make case-sensitive, when filtering the list items.
Default: true
itemTemplate String Function
Specifies a template to customize how the individual list items are displayed in the popup.
Default: null
locale String
Specifies the culture and localization value for this control, overriding the globally defined value.
Default: en-US
noRecordsText String
Specifies the text to be displayed when there are no records to be displayed.
Default: No records found
query Query
Specifies a query that will be executed against the data source before the data source results are bound to the control.
Default: null
scope String
Specifies the scope for dragging and dropping the item. A draggable item will only be accepted by the droppable object if they are in the same scope.
Default: ""
selectionSettings SelectionSettings
Specifies the settings for the selection of list item.
Default: false
toolbarSettings ToolbarSettings
Specifies the settings for the toolbar items.
Default: false
value String[] Number[]
Gets or sets the value of the current selected list item in the control.
Default: null
zIndex Number
Specifies the zIndex of the popup.
Default: 1000
Events
actionBegin EmitType<ActionBeginEventArgs>
Event callback that is raised before retrieving data from the data store.
actionComplete EmitType<ActionCompleteEventArgs>
Event callback that is raised after data has been retrieved from the data store.
actionFailure EmitType<Object>
Event callback that is raised when there is a failure in retrieving data from the data store.
beforeDrop EmitType<DropEventArgs>
Event callback that is raised just before items are dropped into a ListBox control allowing the action to be cancelled.
beforeItemRender EmitType<BeforeItemRenderEventArgs>
Event callback that is raised before each list box item is rendered in the control.
change EmitType<ListBoxChangeEventArgs>
Event callback that is raised when a list box item is selected or unselected.
created EmitType<CreatedEventArgs>
Event callback that is raised when the control has been created.
dataBound EmitType<DataBoundEventArgs>
Event callback that is raised when data has been bound to the control.
destroyed EmitType<Object>
Event callback that is raised when the control has been destroyed.
drag EmitType<DragEventArgs>
Event callback that is raised while a list box item is being dragged.
dragStart EmitType<DragEventArgs>
Event callback that is raised once the dragging of a list box item has begun.
drop EmitType<DropEventArgs>
Event callback that is raised once the item has been dropped into a ListBox control.
filtering EmitType<FilteringEventArgs>
Event callback that is raised while the ListBox is being filtered.