Configuration

An object defining configuration options for the dxSelectBox widget.

attr

Specifies HTML attributes applied to the inner input element of the widget.

Type: Object
Default Value: {}

changeAction

Deprecated

Use the onChange option instead.

closeAction

Deprecated

Use the onClosed option instead.

copyAction

Deprecated

Use the onCopy option instead.

cutAction

Deprecated

Use the onCut option instead.

dataSource

A data source used to fetch data to be displayed by the widget.

Default Value: null

You can assign an array directly to this option as well as use the Data Source provided by the DevExtreme library.

To display widget items, a default template can be used. This template is based on the data source fields that are listed in the Default Item Template section of the widget's API. Alternatively, you can implement a custom item template.

See Also
Show Example:
jQuery

disabled

A Boolean value specifying whether or not the widget can respond to user interaction.

Type: Boolean
Default Value: false

Create an observable variable and assign it to this option to specify the availability of the widget at runtime.

Show Example:
jQuery

displayExpr

Specifies the name of the data source item field whose value is displayed by the widget.

Type: String|function
Default Value: undefined

If the data source item is a simple object holding a value (string, numeric, Boolean, etc.), assign 'this' to the displayExpr option. If the item is a plain object item, assign the required field name or path to the option.

Show Example:
jQuery

displayValue

Returns the value currently displayed by the widget.

Type: String
Default Value: undefined

The value you pass to this option does not affect widget behavior. Pass an observable variable to this option to get the value currently displayed by the widget.

Show Example:
jQuery

editEnabled

Deprecated

Use the fieldEditEnabled option instead.

enterKeyAction

Deprecated

Use the onEnterKey option instead.

fieldEditEnabled

Specifies whether or not the widget allows an end-user to enter a custom value.

Type: Boolean
Default Value: false

fieldTemplate

The template to be used for rendering the widget text field.

Type: String|function|DOM Node|jQuery
Function parameters:
selectedItem: Object
The data that is bound to the selected item.
Return Value: String|DOM Node|jQuery
A template name or a template container.
Default Value: null

This option enables you to render the widget text field depending on selected item values.

HTML
<div data-options="dxTemplate: { name:'myField' }">
    <div data-bind="dxTextBox { value: $data.name + ' (' + $data.capital + ')' } "></p>
</div>

NOTE: A binding context of a field template is the widget's value, that is the currently selected item. So, you can bind template elements to the item's fields directly (see the code above). To access another binding context within a field template, use the Knockout/Angular binding variables.

Show Example:
jQuery

focusInAction

Deprecated

Use the onFocusIn option instead.

focusOutAction

Deprecated

Use the onFocusOut option instead.

focusStateEnabled

Specifies whether or not the widget supports the focused state and keyboard navigation.

Type: Boolean
Default Value: true

height

Specifies the height of the widget.

Type: Number|String|function
Return Value: Number|String
The widget height.
Default Value: undefined

The option can hold a value of the following types.

  • number
    The height of the widget in pixels

  • string
    A CSS measurement of the widget height (e.g., "55px", "80%", "auto" and "inherit")

  • function
    A function returning the widget height (e.g., height:function(){ return baseHeight - 10 + "%"; })

hiddenAction

Deprecated

Use the onClosed option instead.

hint

Specifies the text of the hint displayed for the widget.

Type: String
Default Value: undefined

hoverStateEnabled

A Boolean value specifying whether or not the widget changes its state when being hovered by an end user.

Type: Boolean
Default Value: true

inputAction

Deprecated

Use the onInput option instead.

isValid

Specifies whether the editor's value is valid.

Type: Boolean
Default Value: true

You may need to use an editor to inform end users that an error occurred during the validation of a ViewModel field. In this instance, set the editor's isValid option to the isValid property value of the dxValidator that validated the ViewModel's field. In addition, set the editor's validationError option to the validationError property value of the dxValidator object.

In the code below, the login specified by an end user is validated on the level of the ViewModel. If validation of the login value fails, a validation message is displayed on the Login editor.

HTML
<div data-bind="dxTextBox: { value: login, isValid: login.dxValidator.isValid, validationError: login.dxValidator.validationError, placeholder: 'Login' }"></div>
JavaScript
var viewModel = {
    login: ko.observable("").extend({
        dxValidator: {
            validationRules: [{ type: 'required', message: 'Login is required' }]
        }
    }),
    //...
}

The editor's isValid option, as well as the validationError option, should also be specified when using a custom validation engine. In this instance, the validation result will be displayed for the editor by the means of the DevExtreme Validation UI. For details, refer to the Use Custom Validation Engine topic.

itemRender

Deprecated

Use the itemTemplate option instead.

items

An array of items displayed by the widget.

Type: Array

You can use the dataSource option instead. Unlike the items option, the dataSource option can take on the DataSource configuration object as well as a simple array.

itemTemplate

The template to be used for rendering items.

Type: String|function|DOM Node|jQuery
Function parameters:
itemData: Object
The item object to be rendered.
itemIndex: Number
The index of the item to be rendered.
itemElement: jQuery
An HTML element of the item to be rendered.
Return Value: String|DOM Node|jQuery
A template name or a template container.
Default Value: "item"
See Also

NOTE: A binding context of an item template is the data source object that corresponds to the currently rendered item. So, you can bind template elements to the item object's fields directly (see the code above). To access another binding context within an item template, use the Knockout/Angular binding variables.

Show Example:
jQuery

keyDownAction

Deprecated

Use the onKeyDown option instead.

keyPressAction

Deprecated

Use the onKeyPress option instead.

keyUpAction

Deprecated

Use the onKeyUp option instead.

maxLength

Specifies the maximum number of characters you can enter into the textbox.

Type: String|Number
Default Value: null

If the number of entered characters reaches the value assigned to this option, the widget does not allow you to enter any more characters.

minSearchLength

The minimum number of characters that must be entered into the text box to begin a search.

Type: Number
Default Value: 0

This option makes sense only if the searchEnabled option is set to true.

mode

The "mode" attribute value of the actual HTML input element representing the text box.

Type: String
Default Value: "text"
Accepted Values: 'text'|'email'|'search'|'tel'|'url'|'password'

The value of this option affects the set of keyboard buttons shown on the mobile device when the widget gets focus. In addition, the following mode values add visual features to the widget:

  • 'search' - the text box contains the 'X' button, which clears the text box contents
  • 'password' - the text box shows a password character instead of the actual characters typed

noDataText

The text or HTML markup displayed by the widget if the item collection is empty.

Type: String
Default Value: "No data to display"

onChange

A handler for the change event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
jQueryEvent: jQuery.Event
Specifies the jQuery event that caused action execution.
Default Value: null

Assign a function to perform a custom action when a change within the widget's input element is committed by an end user.

onClosed

A handler for the closed event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
Default Value: null

Assign a function to perform a custom action after a drop-down editor has been hidden.

onContentReady

A handler for the contentReady event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
Default Value: null

If data displayed by the widget is specified using a DataSource instance, the contentReady event fires each time the load() method of the DataSource instance is called as well as when widget content is ready. In this case, when you create the widget, the contentReady event is raised twice: when the widget's content is ready (at this moment, the widget does not display items) and when the DataSource is loaded (the widget displays the loaded items).

onCopy

A handler for the copy event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
jQueryEvent: jQuery.Event
Specifies the jQuery event that caused the action execution.
Default Value: null

Assign a function to perform a custom action after the widget's input is copied.

onCut

A handler for the cut event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
jQueryEvent: jQuery.Event
Specifies the jQuery event that caused the action execution.
Default Value: null

Assign a function to perform a custom action after the widget's input is cut.

onDisposing

A handler for the disposing event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
Default Value: null

Assign a function to perform a custom action when you dispose of this component.

onEnterKey

A handler for the enterKey event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
jQueryEvent: jQuery.Event
Specifies the jQuery event that caused the action execution.
Default Value: null

Assign a function to perform a custom action after a key is entered within the widget's input element.

onFocusIn

A handler for the focusIn event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
jQueryEvent: jQuery.Event
Specifies the jQuery event that caused the action execution.
Default Value: null

Assign a function to perform a custom action after the widget's input is focused.

onFocusOut

A handler for the focusOut event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
jQueryEvent: jQuery.Event
Specifies the jQuery event that caused the action execution.
Default Value: null

Assign a function to perform a custom action after the widget's input element loses focus.

onInput

A handler for the input event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
jQueryEvent: jQuery.Event
Specifies the jQuery event that caused action execution.
Default Value: null

Assign a function to perform a custom action when a value within the widget's input element is changed by an end user.

onItemClick

A handler for the itemClick event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
itemElement: Object
An HTML element of the item.
Default Value: null

Assign a function to perform a custom action when a widget item is clicked.

To navigate to a specific URL when the itemClick event fires, assign that URL directly to this option.

onKeyDown

A handler for the keyDown event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
jQueryEvent: jQuery.Event
Specifies the jQuery event that caused action execution.
Default Value: null

Assign a function to perform a custom action when a key is pressed down within the widget's input element.

onKeyPress

A handler for the keyPress event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
jQueryEvent: jQuery.Event
Specifies the jQuery event that caused the action execution.
Default Value: null

Assign a function to perform a custom action when the keypress DOM event is raised for the current input element.

onKeyUp

A handler for the keyUp event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
jQueryEvent: jQuery.Event
Specifies the jQuery event that caused action execution.
Default Value: null

Assign a function to perform a custom action when a key is released within the widget's input element.

onOpened

A handler for the opened event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
Default Value: null

Assign a function to perform a custom action when the drop-down editor is shown.

onOptionChanged

A handler for the optionChanged event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
value: any
Specifies a new value for the option.
Default Value: null

Assign a function to perform a custom action after an option of the component is changed.

onPaste

A handler for the paste event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
jQueryEvent: jQuery.Event
Specifies the jQuery event that caused the action execution.
Default Value: null

Assign a function to perform a custom action after the widget's input is pasted.

onSelectionChanged

A handler for the selectionChanged event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
selectedItem: Object
Provides access to the currently selected item.
Default Value: null

Assign a function to perform a custom action when the selection changes.

onValueChanged

A handler for the valueChanged event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
value: Object
The widget's new value.
previousValue: Object
The widget's previous value.
itemData: Object
The data that is bound to the new item.
jQueryEvent: jQuery.Event
Specifies the jQuery event that caused the action execution.
Default Value: null

Assign a function to perform a custom action when the editor value changes.

Show Example:
jQuery

openAction

Deprecated

Use the onOpened option instead.

opened

Specifies whether or not the drop-down editor is displayed.

Type: Boolean
Default Value: false

pagingEnabled

Specifies whether or not the widget displays items by pages.

Type: Boolean
Default Value: false

This option makes sense if the DataSource associated with this widget supports paging.

pasteAction

Deprecated

Use the onPaste option instead.

placeholder

The text that is provided as a hint in the select box editor.

Type: String
Default Value: "Select"

readOnly

A Boolean value specifying whether or not the widget is read-only.

Type: Boolean
Default Value: false

rtlEnabled

Specifies whether or not the current component supports a right-to-left representation.

Type: Boolean
Default Value: false

If you need to switch the display of this DevExtreme component to right-to-left, enable a specifically designed configuration option - rtlEnabled. When this option is set to true, the text flows from right to left, and the layout the component's elements is reversed. To switch the entire application/site to a right-to-left representation, use the static DevExpress.rtlEnabled field.

searchEnabled

Specifies whether or not the widget supports searching.

Type: Boolean
Default Value: false

searchExpr

Specifies the name of a data source item field or an expression whose value is compared to the search criterion.

Type: object:Search expression
Default Value: null

searchMode

Specifies the binary operation used to filter data.

Type: String
Default Value: "contains"
Accepted Values: "contains"|"startswith"

searchTimeout

Specifies the time delay, in milliseconds, after the last character has been typed in, before a search is executed.

Type: Number
Default Value: 500

selectedItem

Specifies the currently selected item.

Type: Object
Default Value: null

showClearButton

Specifies whether to display the Clear button in the widget.

Type: Boolean
Default Value: false

The Clear button sets the widget value to undefined.

shownAction

Deprecated

Use the onOpened option instead.

spellcheck

Specifies whether or not the widget checks the inner text for spelling mistakes.

Type: Boolean
Default Value: false

tabIndex

Specifies the widget tab index.

Type: Number
Default Value: 0

text

The read-only option that holds the text displayed by the widget input element.

Type: String

validationError

Holds the object that defines the error that occurred during validation.

Type: Object
Default Value: undefined

You may need to use an editor to inform end users that an error occurred during the validation of a ViewModel field. In this instance, set the editor's isValid option to the isValid property value of the dxValidator that validated the ViewModel's field. In addition, set the editor's validationError option to the validationError property value of the dxValidator object.

In the code, the login specified by an end user is validated on the level of the ViewModel. If validation of the login value fails, a validation message is displayed on the Login editor.

HTML
<div data-bind="dxTextBox: { value: login, isValid: login.dxValidator.isValid, validationError: login.dxValidator.validationError, placeholder: 'Login' }"></div>
JavaScript
var viewModel = {
    login: ko.observable("").extend({
        dxValidator: {
            validationRules: [{ type: 'required', message: 'Login is required' }]
        }
    }),
    //...
}

The editor's validationError option, as well as the isValid option, should also be specified when using a custom validation engine. In this instance, the validation result will be displayed for the editor by the means of the DevExtreme Validation UI. For details, refer to the Use Custom Validation Engine topic.

See Also

validationMessageMode

Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.

Type: String
Default Value: "auto"
Accepted Values: 'auto'|'always'

The following option values are possible:

  • auto
    The tooltip with the message is displayed when the editor is in focus.
  • always
    The tooltip with the message is not hidden when the editor loses focus.

value

The currently selected value in the widget.

Type: String
Default Value: null

If select box items represent objects, the value option returns the value of the specified field of the currently selected item object. The field whose value is returned by the value option is specified via the valueExpr option.

Show Example:
jQuery

valueChangeAction

Deprecated

Use the onValueChanged option instead.

valueExpr

Specifies the name of a data source item field whose value is held in the value configuration option.

Type: String|function
Default Value: null

Assign "this" to this option in order for the widget to return the entire selected object from the value option. Note that the "this" value is not supported by a widget bound to an ODataStore.

Show Example:
jQuery

valueUpdateAction

Deprecated

Use the onValueChanged option instead.

visible

A Boolean value specifying whether or not the widget is visible.

Type: Boolean
Default Value: true

width

Specifies the width of the widget.

Type: Number|String|function
Return Value: Number|String
The widget width.
Default Value: undefined

The option can hold a value of the following types.

  • numeric
    The widget width in pixels.
  • string
    A CSS measurement of the widget width (e.g., "55px", "80%", "auto" and "inherit").
  • function
    The function returning the widget width. For example, see the following code.

    JavaScript
    width: function () { 
        return baseWidth - 10 + "%";
    }