Back to Devexpress

IListBox<TData, TValue> Members

blazor-devexpress-dot-blazor-dot-ilistbox-2-dot-underscore-members.md

latest7.9 KB
Original Source

IListBox<TData, TValue> Members

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

Properties

NameDescription
AttributesSpecifies a collection of standard HTML attributes applied to the component. Inherited from IEditorBase.
ColumnCellDisplayTemplateSpecifies a template used to display column cells in the List Box.
CssClassAssigns a CSS class to the component. Inherited from IEditorBase.
CustomDataSpecifies an asynchronous function that loads editor data based on the specified load options. Inherited from IListEditorBase<TData, TValue>.
DataSpecifies a strongly typed collection that supplies editor data. Inherited from IListEditorBase<TData, TValue>.
DataAsyncSpecifies an asynchronous function that returns editor data. Inherited from IListEditorBase<TData, TValue>.
DisabledFieldNameSpecifies the Boolean field that defines disabled states of component items. Inherited from IListEditorBase<TData, TValue>.
EmptyDataAreaTemplateSpecifies the template used to display custom content in the List Box if there is not items to display.
EnabledSpecifies whether the component can respond to user interactions. Inherited from IEditorBase.
GroupFieldNameSpecifies the name of a data source field whose values are used to group list items. Inherited from IListEditorBase<TData, TValue>.
IdSpecifies the component’s unique identifier. Inherited from IEditorBase.
ItemDisplayTemplateSpecifies a display template for List Box items.
KeyFieldNameSpecifies the field name that contains unique identifiers for component items. Inherited from IListEditorBase<TData, TValue>.
KeyFieldNamesSpecifies 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>.
ListRenderModeSpecifies how an editor renders its items. Inherited from IListEditorBase<TData, TValue>.
ReadOnlySpecifies whether the read-only mode is active. Inherited from IEditorBase.
SearchBoxInputDelaySpecifies the delay between the last input in the search box and when the list box displays matching values.
SearchBoxNullTextSpecifies the prompt text displayed in the search box when it is empty.
SearchTextSpecifies the text that the List Box uses to filter and highlight data.
SearchTextParseModeSpecifies how the list box treats search words.
SelectionModeSpecifies selection mode.
ShowCheckboxesSpecifies whether to display item checkboxes.
ShowSearchBoxSpecifies whether the List Box displays the search box.
ShowValidationSuccessStateSpecifies 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.
SizeModeSpecifies the component’s size. Inherited from IEditorBase.
TextFieldNameSpecifies the data source field that contains text for component items. Inherited from IListEditorBase<TData, TValue>.
ValidationEnabledSpecifies whether the editor validates user input. Inherited from IEditorBase.
ValueGets or sets the selected item’s value.
ValueFieldNameSpecifies the data source field that populates values for component items. Inherited from IListEditorBase<TData, TValue>.
ValuesProvides access to the List Box’s selected value/item collection.

Methods

NameDescription
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.
DeselectAllAsync()Deselects all available items in the List Box.
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>.
SelectAllAsync()Selects all available items in the List Box.
SetFilterCriteria(CriteriaOperator)Applies a filter to list box data.

See Also

IListBox<TData, TValue> Interface

DevExpress.Blazor Namespace