ITagBox<TData, TValue> Properties
An interface that defines the DxTagBox<TData, TValue> component’s API members (properties and methods).| 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. |
| Attributes | Specifies a collection of standard HTML attributes applied to the component. Inherited from IEditorBase. |
| 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 | Assigns a CSS class to the component. Inherited from IEditorBase. |
| 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>. |
| DisabledFieldName | Specifies the Boolean field that defines disabled states of component items. Inherited from IListEditorBase<TData, TValue>. |
| DropDownBodyCssClass | Assigns a CSS class to the drop-down body in the editor. Inherited from IDropDownListEditorBase<TData, TValue>. |
| DropDownCssClass | Assigns 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 the component can respond to user interactions. Inherited from IEditorBase. |
| GroupFieldName | Specifies the name of a data source field whose values are used to group list items. Inherited from IListEditorBase<TData, TValue>. |
| HideSelectedItems | Specifies whether the TagBox hides selected items from the editor’s drop-down list. |
| Id | Specifies the component’s unique identifier. Inherited from IEditorBase. |
| InputCssClass | Assigns 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 IEditorBase. |
| 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>. |
| 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 IEditorBase. |
| SizeMode | Specifies the component’s size. Inherited from IEditorBase. |
| 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 component items. Inherited from IListEditorBase<TData, TValue>. |
| ValidateBy | Specifies if a TagBox located within the standard EditForm is validated by tags or values. |
| ValidationEnabled | Specifies whether the editor validates user input. Inherited from IEditorBase. |
| ValueFieldName | Specifies the data source field that populates values for component items. Inherited from IListEditorBase<TData, TValue>. |
| Values | Provides access to the TagBox’s selected value/item collection. |
See Also