DxTagBox<TData, TValue> Members
An editor that allows users to select multiple items (tags) from the drop-down list.Constructors
Name | Description |
---|---|
DxTagBox() | Initializes a new instance of the DxTagBox<TData, TValue> class. |
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. |
Attributes | Specifies a collection of standard HTML attributes applied to the TagBox. |
ClearButtonDisplayMode | Specifies whether the editor displays the Clear button when it is not empty. Inherited from DxDropDownListEditorBase<TData, TValue>. |
ColumnCellDisplayTemplate | Specifies a template used to display column cells in the TagBox. |
Columns | Allows you to add columns to the TagBox. |
CssClass | Assign a CSS class to the editor. Inherited from DxDropDownListEditorBase<TData, TValue>. |
CustomData | Specifies an asynchronous function that loads the editor’s data based on the specified load options. Inherited from DxDropDownListEditorBase<TData, TValue>. |
Data | Specifies a strongly typed collection that supplies data for the editor. Inherited from DxDropDownListEditorBase<TData, TValue>. |
DataAsync | Specifies an asynchronous function that returns the editor’s data. Inherited from DxDropDownListEditorBase<TData, TValue>. |
DropDownBodyCssClass | Assign a CSS class to the drop-down body in the editor. Inherited from DxDropDownListEditorBase<TData, TValue>. |
DropDownCssClass | Assign a CSS class to the editor’s drop-down. Inherited from DxDropDownListEditorBase<TData, TValue>. |
DropDownDirection | Specifies the direction in which the drop-down window is displayed relative to the editor’s input element. Inherited from DxDropDownListEditorBase<TData, TValue>. |
DropDownVisible | Specifies the current state (displayed/hidden) of the editor’s drop-down window. Inherited from DxDropDownListEditorBase<TData, TValue>. |
DropDownWidthMode | Specifies the width of the drop-down list. Inherited from DxDropDownListEditorBase<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 DxDropDownListEditorBase<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 editor is enabled. Inherited from DxDropDownListEditorBase<TData, TValue>. |
FilteringMode | Obsolete. This property is now obsolete. Use SearchMode and SearchFilterCondition properties instead. Inherited from DxDropDownListEditorBase<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 DxDropDownListEditorBase<TData, TValue>. |
InputCssClass | Assign a CSS class to the editor’s input. Inherited from DxDropDownListEditorBase<TData, TValue>. |
InputId | Specifies a unique identifier (ID) of an editor’s input element. Inherited from DxDropDownListEditorBase<TData, TValue>. |
ItemDisplayTemplate | Specifies a template used to display the TagBox’s items in the drop-down list. |
ItemTemplate | This property is now obsolete. Use the ItemDisplayTemplate property instead. |
KeyFieldName | Specifies the field name that contains unique identifiers for component items. Inherited from DxDropDownListEditorBase<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 DxDropDownListEditorBase<TData, TValue>. |
ListRenderMode | Enables or disables virtual list rendering mode. Inherited from DxDropDownListEditorBase<TData, TValue>. |
NullText |
Specifies the editor’s prompt text when the editor’s value is null .
Inherited from DxDropDownListEditorBase<TData, TValue>. |
ReadOnly | Specifies whether read-only mode is active. Inherited from DxDropDownListEditorBase<TData, TValue>. |
SearchFilterCondition | Specifies the search and filter condition. Inherited from DxDropDownListEditorBase<TData, TValue>. |
SearchMode | Specifies whether the component can search for text that users type in the edit box. Inherited from DxDropDownListEditorBase<TData, TValue>. |
SearchTextParseMode | Specifies how the editor treats search words. Inherited from DxDropDownListEditorBase<TData, TValue>. |
ShowValidationIcon | Specifies whether an editor shows validation icons. Inherited from DxDropDownListEditorBase<TData, TValue>. |
SizeMode | Specifies the size of editor’s inner components (items and checkboxes). Inherited from DxDropDownListEditorBase<TData, TValue>. |
TagDisplayTemplate | Specifies the template to display tags in the edit box. |
Tags | Specifies strings (tags) displayed within the TagBox edit box. |
TagsExpression | Specifies a lambda expression that identifies the Tags property’s bound value when the TagBox is placed in the EditForm. |
TagTemplate | Obsolete. This property is now obsolete. Use the TagDisplayTemplate property instead. |
TextFieldName | Specifies the data source field that contains text for editor’s items. Inherited from DxDropDownListEditorBase<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’s items. Inherited from DxDropDownListEditorBase<TData, TValue>. |
Values | Provides access to the TagBox’s selected value/item collection. |
ValuesExpression | Specifies a lambda expression that identifies the Values property’s bound values when the Tag Box is placed in the EditForm. |
Methods
Name | Description |
---|---|
BeginUpdate() | Suspends the editor updates caused by parameter changes and method calls until the EndUpdate() method is called. Inherited from DxDropDownListEditorBase<TData, TValue>. |
EndUpdate() | Resumes the editor updates (when the BeginUpdate() method pauses updates) and re-renders the List Box. Inherited from DxDropDownListEditorBase<TData, TValue>. |
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. |
FocusAsync() | Moves focus to the editor. Inherited from DxDropDownListEditorBase<TData, TValue>. |
GetHashCode() | Serves as the default hash function. Inherited from Object. |
GetType() | Gets the Type of the current instance. Inherited from Object. |
HideDropDown() | Hides an editor’s drop-down window. Inherited from DxDropDownListEditorBase<TData, TValue>. |
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. |
ShowDropDown() | Displays an editor’s drop-down window. Inherited from DxDropDownListEditorBase<TData, TValue>. |
ToString() | Returns a string that represents the current object. Inherited from Object. |
Events
Name | Description |
---|---|
DropDownVisibleChanged | Fires when an editor’s drop-down window visibility is changed. |
SelectedDataItemsChanged | Fires when selection changes. |
SelectedItemsChanged | Fires after the selection changes. |
TagsChanged | Fires after the Tags collection changed. |
ValuesChanged | Fires after a collection of selected values changes. |
See Also