Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

DxListBox<TData, TValue> Members

A component that can connect to a data source and display a list of selectable items.

#Constructors

Name Description
DxListBox() Initializes a new instance of the DxListBox<TData, TValue> class.

#Properties
Show Inherited Hide Inherited

Name Description
Attributes Specifies a collection of standard HTML attributes applied to the component. Inherited from DxEditorBase.
ColumnCellDisplayTemplate Specifies a template used to display column cells in the List Box.
Columns Allows you to add columns to the List Box.
CssClass Assigns a CSS class to the component. Inherited from DxEditorBase.
CustomData Specifies an asynchronous function that loads a list editor’s data based on the specified load options. Inherited from DxListEditorBase<TData, TValue>.
Data Specifies a strongly typed collection that supplies data for a list editor (ComboBox, List Box, TagBox). Inherited from DxListEditorBase<TData, TValue>.
DataAsync Specifies an asynchronous function that returns data for a list editor (ComboBox, List Box, TagBox). Inherited from DxListEditorBase<TData, TValue>.
DisabledFieldName Specifies the Boolean field that defines disabled states of component items. Inherited from DxListEditorBase<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 DxEditorBase.
GroupFieldName Specifies the name of a data source field whose values are used to group list items. Inherited from DxListEditorBase<TData, TValue>.
GroupHeaderDisplayTemplate Specifies the template used to display group headers when List Box items are grouped.
Id Specifies the component’s unique identifier. Inherited from DxEditorBase.
ItemDisplayTemplate Specifies a display template for List Box items.
ItemTemplate Specifies a template used to display component items. Inherited from DxListEditorBase<TData, TValue>.
KeyFieldName Specifies the key field used for data item identification when the list editor uses a business object as a value. Inherited from DxListEditorBase<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 DxListEditorBase<TData, TValue>.
ListRenderMode Specifies how the list editor renders its items. Inherited from DxListEditorBase<TData, TValue>.
ReadOnly Specifies whether the read-only mode is active. Inherited from DxEditorBase.
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 DxEditorBase.
SizeMode Specifies the component’s size. Inherited from DxEditorBase.
TextFieldName Specifies the data source field that contains text for component items. Inherited from DxListEditorBase<TData, TValue>.
ValidationEnabled Specifies whether the editor validates user input. Inherited from DxEditorBase.
Value Gets or sets the selected item value.
ValueExpression Specifies a lambda expression that identifies the Value property’s bound value when the List Box is in the EditForm.
ValueFieldName Specifies the data source field that populates values for component items. Inherited from DxListEditorBase<TData, TValue>.
Values Provides access to the List Box’s selected value/item collection.
ValuesExpression Specifies a lambda expression that identifies the Values property’s bound values when the List Box is placed in the EditForm.

#Methods
Show Inherited Hide Inherited

Name Description
BeginUpdate() Suspends component updates caused by parameter changes and method calls until the EndUpdate() method is called. Inherited from DxEditorBase.
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 DxEditorBase.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
GetFilterCriteria() Returns the filter criteria applied to List Box data.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetType() Gets the Type of the current instance. Inherited from Object.
MakeDataItemVisibleAsync(TData) Makes the row bound to the specified data item visible on screen.
MakeItemVisible(Int32) Makes the item with the specified index visible on screen.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
Reload() Reloads a list editor’s data. Inherited from DxListEditorBase<TData, TValue>.
SetFilterCriteria(CriteriaOperator) Applies a filter to List Box data.
ToString() Returns a string that represents the current object. Inherited from Object.

#Events

Name Description
FilterCriteriaChanged Fires when filter criteria applied to List Box data change.
SearchTextChanged Fires when the search text changes.
SelectedDataItemsChanged Fires when selection changes.
SelectedItemsChanged Fires after the selection changes.
ValueChanged Allows you to respond to the List Box’s selected value changes.
ValuesChanged Fires after a collection of selected values changes.
See Also