IListBox<TData, TValue> Members
An interface that defines the DxListBox<TData, TValue> component’s API members (properties and methods).Properties
| Name | Description |
|---|---|
| ColumnCellDisplayTemplate | Specifies a template used to display column cells in the List Box. |
| CssClass | Assign a CSS class to an editor. Inherited from IListEditorBase<TData, TValue>. |
| 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>. |
| EmptyDataAreaTemplate | Specifies the template used to display custom content in the List Box if there is not items to display. |
| Enabled | Specifies whether an editor can respond to user interactions. Inherited from IListEditorBase<TData, TValue>. |
| 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 IListEditorBase<TData, TValue>. |
| 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 editor’s inner components (items and checkboxes). Inherited from IListEditorBase<TData, TValue>. |
| TextFieldName | Specifies the data source field that contains text for editor items. Inherited from IListEditorBase<TData, TValue>. |
| Value | Gets or sets the selected item’s value. |
| ValueFieldName | Specifies the data source field that populates values for the editor items. Inherited from IListEditorBase<TData, TValue>. |
| Values | Provides access to the List Box’s selected value/item collection. |
Methods
| Name | Description |
|---|---|
| BeginUpdate() |
Suspends list editor updates caused by parameter changes and method calls until the EndUpdate method is called.
Inherited from IListEditorBase<TData, TValue>. |
| ClearFilter() | Clears the filter applied to list box data. |
| EndUpdate() |
Resumes an editor updates (when the BeginUpdate method pauses updates) and re-renders the editor.
Inherited from IListEditorBase<TData, TValue>. |
| 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. |
| SetFilterCriteria(CriteriaOperator) | Applies a filter to list box data. |
See Also