Skip to main content

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

Name Description
Attributes Specifies a collection of standard HTML attributes applied to the List Box.
ColumnCellDisplayTemplate Specifies a template used to display column cells in the List Box.
Columns Allows you to add columns to the List Box.
CssClass Specifies the name of a CSS class applied to the List Box.
CustomData Specifies an asynchronous function that loads List Box data based on the specified load options.
Data Specifies a strongly typed collection that supplies List Box data.
DataAsync Specifies an asynchronous function that returns List Box data.
EmptyDataAreaTemplate Specifies the template used to display custom content in the List Box if there is not items to display.
Enabled Specifies whether the List Box can respond to user interactions.
ItemDisplayTemplate Specifies a display template for List Box items.
ItemTemplate Specifies a template used to display the ListBox’s items.
ListRenderMode Specifies how the List Box component renders its items.
ReadOnly Specifies whether the read-only mode is active.
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.
SizeMode Specifies the size of List Box inner components (items and checkboxes).
TextFieldName Specifies the data source field that contains text for List Box items.
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 the List Box’s items.
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

Name Description
BeginUpdate() Suspends List Box updates caused by parameter changes and method calls until the EndUpdate() method is called.
ClearFilter() Clears the filter applied to list box data.
EndUpdate() Resumes List Box updates (when the BeginUpdate() method pauses updates) and re-renders the List Box.
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.
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