Skip to main content

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 component. Inherited from DxEditorBase.
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 Assigns a CSS class to the component. Inherited from DxEditorBase.
CustomData Specifies an asynchronous function that loads a list editor’s data based on the specified load options. Inherited from DxListEditorBase<TData, TValue>.
Data Specifies a strongly typed collection that supplies data for a list editor (ComboBox, List Box, TagBox). Inherited from DxListEditorBase<TData, TValue>.
DataAsync Specifies an asynchronous function that returns data for a list editor (ComboBox, List Box, TagBox). Inherited from DxListEditorBase<TData, TValue>.
DisabledFieldName Specifies the Boolean field that defines disabled states of component items. Inherited from DxListEditorBase<TData, TValue>.
DropDownBodyCssClass Assigns a CSS class to the drop-down body in the editor. Inherited from DxDropDownListEditorBase<TData, TValue>.
DropDownCssClass Assigns 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 component can respond to user interactions. Inherited from DxEditorBase.
FilteringMode Obsolete. This property is now obsolete. Use SearchMode and SearchFilterCondition properties instead. Inherited from DxDropDownListEditorBase<TData, TValue>.
GroupFieldName Specifies the name of a data source field whose values are used to group list items. Inherited from DxListEditorBase<TData, TValue>.
GroupHeaderDisplayTemplate Specifies the template used to display group headers when TagBox items are grouped.
HideSelectedItems Specifies whether the TagBox hides selected items from the editor’s drop-down list.
Id Specifies the component’s unique identifier. Inherited from DxEditorBase.
InputCssClass Assigns 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 Specifies a template used to display component items. Inherited from DxListEditorBase<TData, TValue>.
KeyFieldName Specifies the key field used for data item identification when the list editor uses a business object as a value. Inherited from DxListEditorBase<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 DxListEditorBase<TData, TValue>.
ListRenderMode Specifies how the list editor renders its items. Inherited from DxListEditorBase<TData, TValue>.
NullText Specifies the editor’s prompt text when the editor’s value is null. Inherited from DxDropDownListEditorBase<TData, TValue>.
ReadOnly Specifies whether the read-only mode is active. Inherited from DxEditorBase.
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>.
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 DxEditorBase.
SizeMode Specifies the component’s size. Inherited from DxEditorBase.
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 This property is now obsolete. Use the TagDisplayTemplate property instead.
TextFieldName Specifies the data source field that contains text for component items. Inherited from DxListEditorBase<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 DxEditorBase.
ValueFieldName Specifies the data source field that populates values for component items. Inherited from DxListEditorBase<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 component updates caused by parameter changes and method calls until the EndUpdate() method is called. Inherited from DxEditorBase.
EndUpdate() Resumes component updates (when the BeginUpdate() method pauses updates) and re-renders the component. Inherited from DxEditorBase.
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.
Reload() Reloads a list editor’s data. Inherited from DxListEditorBase<TData, TValue>.
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. Inherited from DxDropDownListEditorBase<TData, TValue>.
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