DxComboBox<TData, TValue> Members
A text editor that allows users to select predefined items from the drop-down list or type custom values.Constructors
Name | Description |
---|---|
DxComboBox() | Initializes a new instance of the DxComboBox<TData, TValue> class. |
Properties
Name | Description |
---|---|
AllowUserInput | Specifies whether users can enter custom values in the edit box of the ComboBox. |
Attributes | Specifies a collection of standard HTML attributes applied to the ComboBox. |
Buttons | Allows you to add command buttons to the ComboBox. |
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 ComboBox. |
Columns | Allows you to add columns to the ComboBox. |
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>. |
DisplayFormat | Specifies the pattern used to format the ComboBox’s display value when the editor is not focused. |
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>. |
DropDownTriggerMode | Specify when the ComboBox should open its drop-down list. |
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 ComboBox’s item in the edit box. |
EditBoxTemplate | Specifies a template used to display the ComboBox’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 ComboBox 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>. |
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 ComboBox’s items. |
ItemTemplate | Specifies a template used to display the ComboBox’s items. |
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>. |
ShowDropDownButton | Specifies whether the ComboBox displays the built-in button that invokes a drop-down menu. |
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>. |
Text | Specifies the text displayed in the edit box of the ComboBox. |
TextExpression | Specifies a lambda expression that identifies the Text property’s bound value when a ComboBox is placed in the EditForm. |
TextFieldName | Specifies the data source field that contains text for editor’s items. Inherited from DxDropDownListEditorBase<TData, TValue>. |
ValidateBy | Specifies which ComboBox property takes part in input validation. |
Value | Specifies the ComboBox’s selected value/item. |
ValueExpression | Specifies a lambda expression that identifies the Value property’s bound value when the ComboBox is placed in the EditForm. |
ValueFieldName | Specifies the data source field that populates values for the editor’s items. Inherited from DxDropDownListEditorBase<TData, TValue>. |
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. |
SelectedDataItemChanged | Fires when the ComboBox’s selected item is changed. |
SelectedItemChanged | Fires when the ComboBox’s selected item is changed. |
TextChanged | Allows you to react to the ComboBox editor’s text changes. |
ValueChanged | Fires when the ComboBox’s selected value changes. |
See Also