Skip to main content
All docs
V24.1

ITagBox<TData, TValue> Members

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

Properties

Name Description
AllowCustomTags Specifies whether users are allowed to input custom tags that are not stored in a bound data source in a TagBox editor.
ClearButtonDisplayMode Specifies whether the editor displays the Clear button when it is not empty. Inherited from IDropDownListEditorBase<TData, TValue>.
ColumnCellDisplayTemplate Specifies a template used to display column cells in the TagBox.
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>.
DropDownBodyCssClass Assign a CSS class to the drop-down body in the editor. Inherited from IDropDownListEditorBase<TData, TValue>.
DropDownCssClass Assign a CSS class to the editor’s drop-down. Inherited from IDropDownListEditorBase<TData, TValue>.
DropDownDirection Specifies the direction in which the drop-down window is displayed relative to the editor’s input element. Inherited from IDropDownListEditorBase<TData, TValue>.
DropDownVisible Specifies the current state (displayed/hidden) of a drop-down window. Inherited from IDropDownListEditorBase<TData, TValue>.
DropDownWidthMode Specifies the width of the drop-down list. Inherited from IDropDownListEditorBase<TData, TValue>.
EditBoxDisplayTemplate Specifies a template used to display the TagBox’s item in the edit box.
EditFormat Specifies the pattern used to format the editor’s value. Inherited from IDropDownListEditorBase<TData, TValue>.
EmptyDataAreaTemplate Specifies the template used to display custom content in the TagBox if there is not items to display.
Enabled Specifies whether an editor can respond to user interactions. Inherited from IListEditorBase<TData, TValue>.
HideSelectedItems Specifies whether the TagBox hides selected items from the editor’s drop-down list.
Id Specifies the editor’s unique identifier. Inherited from IDropDownListEditorBase<TData, TValue>.
InputCssClass Assign a CSS class to the editor’s input. Inherited from IDropDownListEditorBase<TData, TValue>.
InputId Specifies a unique identifier (ID) of an editor’s input element. Inherited from IDropDownListEditorBase<TData, TValue>.
ItemDisplayTemplate Specifies a template used to display the TagBox’s items in the drop-down list.
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>.
NullText Specifies the editor’s prompt text when the editor’s value is null. Inherited from IDropDownListEditorBase<TData, TValue>.
ReadOnly Specifies whether the read-only mode is active. Inherited from IListEditorBase<TData, TValue>.
SearchFilterCondition Specifies the search and filter condition. Inherited from IDropDownListEditorBase<TData, TValue>.
SearchMode Specifies whether the component can search for text that users type in the edit box. Inherited from IDropDownListEditorBase<TData, TValue>.
SearchTextParseMode Specifies how the editor treats search words. Inherited from IDropDownListEditorBase<TData, TValue>.
ShowValidationIcon Specifies whether an editor shows validation icons. Inherited from IDropDownListEditorBase<TData, TValue>.
SizeMode Specifies the size of editor’s inner components (items and checkboxes). Inherited from IListEditorBase<TData, TValue>.
TagDisplayTemplate Specifies the template to display tags in the edit box.
Tags Specifies strings (tags) displayed within the TagBox edit box.
TextFieldName Specifies the data source field that contains text for editor items. Inherited from IListEditorBase<TData, TValue>.
ValidateBy Specifies if a TagBox located within the standard EditForm is validated by tags or values.
ValueFieldName Specifies the data source field that populates values for the editor items. Inherited from IListEditorBase<TData, TValue>.
Values Provides access to the TagBox’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>.
EndUpdate() Resumes an editor updates (when the BeginUpdate method pauses updates) and re-renders the editor. Inherited from IListEditorBase<TData, TValue>.
HideDropDown() Hides an editor’s drop-down window. Inherited from IDropDownListEditorBase<TData, TValue>.
ShowDropDown() Displays an editor’s drop-down window. Inherited from IDropDownListEditorBase<TData, TValue>.
See Also