Skip to main content
All docs
V24.2

IListBox<TData, TValue> Members

An interface that defines the DxListBox<TData, TValue> component’s API members (properties and methods).

Properties

Name Description
Attributes Specifies a collection of standard HTML attributes applied to the component. Inherited from IEditorBase.
ColumnCellDisplayTemplate Specifies a template used to display column cells in the List Box.
CssClass Assigns a CSS class to the component. Inherited from IEditorBase.
CustomData Specifies an asynchronous function that loads editor data based on the specified load options. Inherited from IListEditorBase<TData, TValue>.
Data Specifies a strongly typed collection that supplies editor data. Inherited from IListEditorBase<TData, TValue>.
DataAsync Specifies an asynchronous function that returns editor data. Inherited from IListEditorBase<TData, TValue>.
DisabledFieldName Specifies the Boolean field that defines disabled states of component items. Inherited from IListEditorBase<TData, TValue>.
EmptyDataAreaTemplate Specifies the template used to display custom content in the List Box if there is not items to display.
Enabled Specifies whether the component can respond to user interactions. Inherited from IEditorBase.
GroupFieldName Specifies the name of a data source field whose values are used to group list items. Inherited from IListEditorBase<TData, TValue>.
Id Specifies the component’s unique identifier. Inherited from IEditorBase.
ItemDisplayTemplate Specifies a display template for List Box items.
KeyFieldName Specifies the field name that contains unique identifiers for component items. Inherited from IListEditorBase<TData, TValue>.
KeyFieldNames Specifies the names of data fields that contain key values. The combination of key values forms a unique identifier for a component item. Inherited from IListEditorBase<TData, TValue>.
ListRenderMode Specifies how an editor renders its items. Inherited from IListEditorBase<TData, TValue>.
ReadOnly Specifies whether the read-only mode is active. Inherited from IEditorBase.
SearchText Specifies the text that the List Box uses to filter and highlight data.
SearchTextParseMode Specifies how the list box treats search words.
SelectionMode Specifies selection mode.
ShowCheckboxes Specifies whether to display item checkboxes.
ShowSearchBox Specifies whether the List Box displays the search box.
ShowValidationSuccessState Specifies whether the editor indicates successful validation. When an input value is valid, the editor displays a green outline and can show a success icon. Inherited from IEditorBase.
SizeMode Specifies the component’s size. Inherited from IEditorBase.
TextFieldName Specifies the data source field that contains text for component items. Inherited from IListEditorBase<TData, TValue>.
ValidationEnabled Specifies whether the editor validates user input. Inherited from IEditorBase.
Value Gets or sets the selected item’s value.
ValueFieldName Specifies the data source field that populates values for component items. Inherited from IListEditorBase<TData, TValue>.
Values Provides access to the List Box’s selected value/item collection.

Methods

Name Description
BeginUpdate() Suspends component updates caused by parameter changes and method calls until the EndUpdate() method is called. Inherited from IEditorBase.
ClearFilter() Clears the filter applied to list box data.
EndUpdate() Resumes component updates (when the BeginUpdate() method pauses updates) and re-renders the component. Inherited from IEditorBase.
GetFilterCriteria() Returns the filter criteria applied to the grid data.
MakeDataItemVisibleAsync(TData) Makes the row bound to the specified data item visible on screen.
MakeItemVisible(Int32) Makes the item visible on screen.
Reload() Reloads a list editor’s data. Inherited from IListEditorBase<TData, TValue>.
SetFilterCriteria(CriteriaOperator) Applies a filter to list box data.
See Also