Configuration

An object defining configuration options for the TextBox widget.

accessKey

Specifies a shortcut key that sets focus on the widget element.

Type: String
Default Value: null

The accessKey option value is passed to the accesskey attribute of the actual HTML element of the widget.

activeStateEnabled

A Boolean value specifying whether or not the widget changes its state when interacting with a user.

Type: Boolean
Default Value: false

This option is used when the widget is displayed on a platform whose guidelines include the active state change for widgets.

attr

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

Type: Object
Default Value: {}

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:
AngularJS
Knockout
jQuery

focusStateEnabled

Specifies whether or not the widget can be focused.

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.,

    JavaScript
    height: function () {
        return baseHeight - 10 + "%";
    });

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

isValid

Specifies whether the editor's value is valid.

Type: Boolean
Default Value: true

In Knockout approach, 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'
            }]
        }
    }),
    //...
}
NOTE
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.
See Also

mask

The editor mask that specifies the format of the entered string.

Type: String
Default Value: ''

A mask can contain the following elements.

Masking Element Description
0 A digit.
9 A digit or a space.
# A digit, a space, "+" or "-" sign.
L A literal.
C Any character except space.
c Any character.
A An alphanumeric.
a An alphanumeric or a space.
NOTE
To escape the masking elements, use the double backslash character (\). For example, "000.\\0\\0".
Show Example:
AngularJS
Knockout
jQuery

maskChar

Specifies a mask placeholder character.

Type: String
Default Value: '_'

Show Example:
AngularJS
Knockout
jQuery

maskInvalidMessage

A message displayed when the entered text does not match the specified pattern.

Type: String
Default Value: 'Value is invalid'

maskRules

Specifies custom mask rules.

Type: Object
Default Value: '{}'

Each field of an object passed to this option corresponds to a single rule. A field name is a character used in a mask enclosed in quotes. A field accepts the following values.

JavaScript
var CustomMaskRules = {
    // a single character
    's': '$',

    // a regular expression
    'h': /[0-9A-F]/,

    // an array of characters
    'n': ['$', '%', '&', '@'],

    // a function
    'f': function(char) {
        var allowedChars = ['a', 'b', 'c', '$', '_', '.'];
        for(var i = 0; i < allowedChars.length; i++) {
            if (char === allowedChars[i])
                return true;
        }
        return false;
     }
}

A function that specifies a custom rule accepts a character as an argument and returns a Boolean value that specifies whether or not the character is appropriate.

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.

Show Example:
AngularJS
Knockout
jQuery

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

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. Available only in the Knockout approach.
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.

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. Available only in the Knockout approach.
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. Available only in the Knockout approach.
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. Available only in the Knockout approach.
Default Value: null

Assign a function to perform a custom action when the widget is being removed.

NOTE
The function assigned to this option is executed only if the widget is removed using the remove(), empty(), or html() jQuery methods.

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. Available only in the Knockout approach.
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 'Enter' key is pressed 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. Available only in the Knockout approach.
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. Available only in the Knockout approach.
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.

onInitialized

A handler for the initialized 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.
Default Value: null

Assign a function to perform a custom action when the widget is initialized.

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. Available only in the Knockout approach.
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.

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. Available only in the Knockout approach.
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. Available only in the Knockout approach.
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. Available only in the Knockout approach.
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.

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.
name: String
Specifies the name of the option whose value is changed.
fullName: String
Specifies a full name of the option whose value is changed. The full name is formed by concatenating the names of the options that are presented in the hierarchy of the given option. The names are delimited by commas.
value: any
Specifies a new value for the option.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
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. Available only in the Knockout approach.
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.

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. Available only in the Knockout approach.
value: Object
The widget's new value.
previousValue: Object
The widget's previous value.
jQueryEvent: jQuery.Event
Specifies the jQuery event that caused action execution.
Default Value: null

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

Show Example:
AngularJS
Knockout
jQuery

placeholder

The text displayed by the widget when the widget value is empty.

Type: String
Default Value: ''

Show Example:
AngularJS
Knockout
jQuery

readOnly

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

Type: Boolean
Default Value: false

Show Example:
AngularJS
Knockout
jQuery

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.

showClearButton

Specifies whether to display the Clear button in the widget.

Type: Boolean
Default Value: false

The Clear button sets the widget value to null.

Show Example:
AngularJS
Knockout
jQuery

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
Read-only

useMaskedValue

Specifies whether the value should contain mask characters or not.

Type: Boolean
Default Value: false

If false, the value contains raw user input; if true, the value contains mask characters as well. This option applies only if a mask is specified.

Show Example:
AngularJS
Knockout
jQuery

validationError

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

Type: Object
Default Value: undefined

In Knockout approach, 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.

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

Specifies the current value displayed by the widget.

Type: String
Default Value: ''

valueChangeEvent

Specifies DOM event names that update a widget's value.

Type: String
Default Value: 'change'

The option takes on a string value representing a DOM event name or several DOM event names separated by a space. It is recommended that you use the "keyup", "blur", "change" and "focusout" events. However, you can use other DOM events for your own discretion.

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 + "%";
    }