Vue TextBox Props

An object defining configuration options for the TextBox widget.

See Also

accessKey

Specifies the shortcut key that sets focus on the widget.

Type:

String

Default Value: null

The value of this option will be passed to the accesskey attribute of the HTML element that underlies the widget.

activeStateEnabled

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

buttons[]

Allows you to add custom buttons to the input text field.

Type:

Array<String | Object>

Default Value: undefined
Accepted Values: 'clear'

Built-in buttons should also be declared in this array. You can find an example in the following demo:

View Demo

disabled

Specifies whether the widget responds to user interaction.

Type:

Boolean

Default Value: false

elementAttr

Specifies the attributes to be attached to the widget's root element.

Type:

Object

Default Value: {}

jQuery
$(function(){
    $("#textBoxContainer").dxTextBox({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});
Angular
HTML
TypeScript
<dx-text-box ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-text-box>
import { DxTextBoxModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxTextBoxModule
    ],
    // ...
})
ASP.NET MVC Controls
Razor C#
Razor VB
@(Html.DevExtreme().TextBox()
    .ElementAttr("class", "class-name")
    // ===== or =====
    .ElementAttr(new {
        @id = "elementId",
        @class = "class-name"
    })
    // ===== or =====
    .ElementAttr(new Dictionary<string, object>() {
        { "id", "elementId" },
        { "class", "class-name" }
    })

)
@(Html.DevExtreme().TextBox() _
    .ElementAttr("class", "class-name")
    ' ===== or =====
    .ElementAttr(New With {
        .id = "elementId",
        .class = "class-name"
    })
    ' ===== or =====
    .ElementAttr(New Dictionary(Of String, Object) From {
        { "id", "elementId" },
        { "class", "class-name" }
    })
)

focusStateEnabled

Specifies whether the widget can be focused using keyboard navigation.

Type:

Boolean

Default Value: true

height

Specifies the widget's height.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The widget's height.

Default Value: undefined

This option accepts a value of one of the following types:

  • Number
    The height in pixels.

  • String
    A CSS-accepted measurement of height. For example, "55px", "80%", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    height: function() {
        return window.innerHeight / 1.5;
    }

hint

Specifies text for a hint that appears when a user pauses on the widget.

Type:

String

Default Value: undefined

hoverStateEnabled

Specifies whether the widget changes its state when a user pauses on it.

Type:

Boolean

Default Value: true

inputAttr

Specifies the attributes to be passed on to the underlying HTML element.

Type:

Object

Default Value: {}

jQuery
$(function(){
    $("#textBoxContainer").dxTextBox({
        // ...
        inputAttr: {
            id: "inputId"
        }
    });
});
Angular
HTML
TypeScript
<dx-text-box ...
    [inputAttr]="{ id: 'inputId' }">
</dx-text-box>
import { DxTextBoxModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxTextBoxModule
    ],
    // ...
})
ASP.NET MVC Controls
Razor C#
Razor VB
@(Html.DevExtreme().TextBox()
    .InputAttr("id", "inputId")
    // ===== or =====
    .InputAttr(new {
        @id = "inputId"
    })
    // ===== or =====
    .InputAttr(new Dictionary<string, object>() {
        { "id", "inputId" }
    })
)
@(Html.DevExtreme().TextBox() _
    .InputAttr("id", "inputId")
    ' ===== or =====
    .InputAttr(New With {
        .id = "inputId"
    })
    ' ===== or =====
    .InputAttr(New Dictionary(Of String, Object) From {
        { "id", "inputId" }
    })
)

isValid

Specifies whether the editor's value is valid.

Type:

Boolean

Default Value: true

mask

The editor mask that specifies the custom 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".

maskChar

Specifies a mask placeholder character.

Type:

String

Default Value: '_'

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.

mode

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

Type:

String

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

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

Use the TextBoxMode enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Text, Email, Search, Tel, Url, and Password.

View Demo

name

The value to be assigned to the name attribute of the underlying HTML element.

Type:

String

Default Value: ''

Specify this option if the widget lies within an HTML form that will be submitted.

If you configure the widget as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control, use this option to bind the widget to a model property. If this model property contains Data Annotation validation attributes, you get the client-side validation enabled by default.

onChange

A function that is executed when the widget loses focus after the text field's content was changed using the keyboard.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

TextBox

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

model

Object

The model data. Available only if Knockout is used.

Default Value: null

onContentReady

A function that is executed when the widget's content is ready and each time the content is changed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

TextBox

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

The model data. Available only when using Knockout.

Default Value: null

onCopy

A function that is executed when the widget's input has been copied.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

TextBox

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

model

Object

The model data. Available only if Knockout is used.

Default Value: null

onCut

A function that is executed when the widget's input has been cut.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

TextBox

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

model

Object

The model data. Available only if Knockout is used.

Default Value: null

onDisposing

A function that is executed before the widget is disposed of.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

TextBox

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

The model data. Available only if you use Knockout.

Default Value: null

onEnterKey

A function that is executed when the Enter key has been pressed while the widget is focused.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

TextBox

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

model

Object

The model data. Available only if Knockout is used.

Default Value: null

NOTE
This function is executed after the onKeyUp, onKeyDown, and onKeyPress functions.

onFocusIn

A function that is executed when the widget gets focus.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

component

TextBox

The widget's instance.

model

Object

The model data. Available only if Knockout is used.

Default Value: null

onFocusOut

A function that is executed when the widget loses focus.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

component

TextBox

The widget's instance.

model

Object

The model data. Available only if Knockout is used.

Default Value: null

onInitialized

A function used in JavaScript frameworks to save the widget instance.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

TextBox

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

Default Value: null

See Also

onInput

A function that is executed each time the widget's input is changed while the widget is focused.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

TextBox

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

model

Object

The model data. Available only if Knockout is used.

Default Value: null

onKeyDown

A function that is executed when a user is pressing a key on the keyboard.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

TextBox

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

model

Object

The model data. Available only if Knockout is used.

Default Value: null

onKeyPress

A function that is executed when a user presses a key on the keyboard.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

TextBox

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

model

Object

The model data. Available only if Knockout is used.

Default Value: null

IMPORTANT
The keyPress event is removed from the web standards and will be deprecated in modern browsers soon. Refer to the MDN topic for details.

onKeyUp

A function that is executed when a user releases a key on the keyboard.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

TextBox

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

model

Object

The model data. Available only if Knockout is used.

Default Value: null

onOptionChanged

A function that is executed after a widget option is changed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
model

Object

The model data. Available only if you use Knockout.

fullName

String

The path to the modified option that includes all parent options.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

component

TextBox

The widget's instance.

name

String

The modified option if it belongs to the first level. Otherwise, the first-level option it is nested into.

value any

The modified option's new value.

Default Value: null

onPaste

A function that is executed when the widget's input has been pasted.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

TextBox

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

model

Object

The model data. Available only if Knockout is used.

Default Value: null

onValueChanged

A function that is executed after the widget's value is changed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

TextBox

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

model

Object

The model data. Available only if Knockout is used.

previousValue

Object

The widget's previous value.

value

Object

The widget's new value.

Default Value: null

placeholder

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

Type:

String

Default Value: ''

readOnly

Specifies whether the editor is read-only.

Type:

Boolean

Default Value: false

When this option is set to true, the following applies:

  • The editor's value cannot be changed using the UI.
  • Built-in action buttons are invisible.
  • Custom action buttons are visible but disabled. If a button should not be disabled, set its disabled option to false:

    jQuery
    index.js
    $(function() {
        $("#textBoxContainer").dxTextBox({
            // ...
            buttons: [{
                name: "myCustomButton",
                location: "after",
                options: {
                    onClick: function(e) {
                        // ...
                    },
                    disabled: false
                }
            }]
        });
    });
    Angular
    app.component.html
    app.component.ts
    app.module.ts
    <dx-text-box ... >
        <dxi-button
            name="myCustomButton"
            location="after"
            [options]="myCustomButtonConfig">
        </dxi-button>
    </dx-text-box>
    import { Component } from '@angular/core';
    
    @Component({
        selector: 'app-root',
        templateUrl: './app.component.html',
        styleUrls: ['./app.component.css']
    })
    export class AppComponent {
        myCustomButtonConfig = {
            onClick: (e) => {
                // ...
            },
            disabled: false
        };
    }
    import { BrowserModule } from '@angular/platform-browser';
    import { NgModule } from '@angular/core';
    import { AppComponent } from './app.component';
    
    import { DxTextBoxModule } from 'devextreme-angular';
    
    @NgModule({
        declarations: [
            AppComponent
        ],
        imports: [
            BrowserModule,
            DxTextBoxModule
        ],
        providers: [ ],
        bootstrap: [AppComponent]
    })
    export class AppModule { }
    Vue
    App.vue
    <template>
        <DxTextBox ... >
            <DxTextBoxButton
                name="myCustomButton"
                location="after"
                :options="myCustomButtonConfig"
            />
        </DxTextBox>
    </template>
    
    <script>
    import 'devextreme/dist/css/dx.common.css';
    import 'devextreme/dist/css/dx.light.css';
    
    import DxTextBox, {
        DxButton as DxTextBoxButton
    } from 'devextreme-vue/text-box';
    
    export default {
        components: {
            DxTextBox,
            DxTextBoxButton
        },
        data() {
            return {
                myCustomButtonConfig: {
                    onClick: (e) => {
                        // ...
                    },
                    disabled: false
                }
            }
        }
    }
    </script>
    React
    App.js
    import React from 'react';
    
    import 'devextreme/dist/css/dx.common.css';
    import 'devextreme/dist/css/dx.light.css';
    
    import TextBox, {
        Button as TextBoxButton
    } from 'devextreme-react/text-box';
    
    class App extends React.Component {
        myCustomButtonConfig = {
            onClick: (e) => {
                // ...
            },
            disabled: false
        };
        render() {
            return (
                <TextBox>
                    <TextBoxButton
                        name="myCustomButton"
                        location="after"
                        options={this.myCustomButtonConfig}
                    />
                </TextBox>
            );
        }
    }
    export default App;

    You can also hide a custom action button when the widget becomes read-only. Set the button's visible option to false in the onOptionChanged function. To get the button, use the getButton(name) method:

    jQuery
    index.js
    $(function() {
        $("#textBoxContainer").dxTextBox({
            // ...
            buttons: [{
                name: "myCustomButton",
                // ...
            }],
            onOptionChanged: function(e) {
                if(e.name == "readOnly") {
                    var myButton = e.component.getButton("myCustomButton");
                    myButton.option("visible", !e.value); // Hide the button when readOnly: true
                }
            }
        });
    });
    Angular
    app.component.html
    app.component.ts
    app.module.ts
    <dx-text-box ...
        (onOptionChanged)="changeButtonState">
        <dxi-button
            name="myCustomButton"
            ...
        ></dxi-button>
    </dx-text-box>
    import { Component } from '@angular/core';
    
    @Component({
        selector: 'app-root',
        templateUrl: './app.component.html',
        styleUrls: ['./app.component.css']
    })
    export class AppComponent {
        changeButtonState(e) {
            if(e.name == 'readOnly') {
                let myButton = e.component.getButton('myCustomButton');
                myButton.option('visible', !e.value); // Hide the button when readOnly: true
            }
        }
    }
    import { BrowserModule } from '@angular/platform-browser';
    import { NgModule } from '@angular/core';
    import { AppComponent } from './app.component';
    
    import { DxTextBoxModule } from 'devextreme-angular';
    
    @NgModule({
        declarations: [
            AppComponent
        ],
        imports: [
            BrowserModule,
            DxTextBoxModule
        ],
        providers: [ ],
        bootstrap: [AppComponent]
    })
    export class AppModule { }
    Vue
    App.vue
    <template>
        <DxTextBox ...
            @option-changed="changeButtonState">
            <DxTextBoxButton
                name="myCustomButton"
                ...
            />
        </DxTextBox>
    </template>
    
    <script>
    import 'devextreme/dist/css/dx.common.css';
    import 'devextreme/dist/css/dx.light.css';
    
    import DxTextBox, {
        DxButton as DxTextBoxButton
    } from 'devextreme-vue/text-box';
    
    export default {
        components: {
            DxTextBox,
            DxTextBoxButton
        },
        data() {
            return {
                // ...
            }
        },
        methods: {
            changeButtonState(e) {
                if(e.name == 'readOnly') {
                    let myButton = e.component.getButton('myCustomButton');
                    myButton.option('visible', !e.value); // Hide the button when readOnly: true
                }
            }
        }
    }
    </script>
    React
    App.js
    import React from 'react';
    
    import 'devextreme/dist/css/dx.common.css';
    import 'devextreme/dist/css/dx.light.css';
    
    import TextBox, {
        Button as TextBoxButton
    } from 'devextreme-react/text-box';
    
    class App extends React.Component {
        changeButtonState(e) {
            if(e.name == 'readOnly') {
                let myButton = e.component.getButton('myCustomButton');
                myButton.option('visible', !e.value); // Hide the button when readOnly: true
            }
        }
        render() {
            return (
                <TextBox ...
                    onOptionChanged={this.changeButtonState}>
                    <TextBoxButton
                        name="myCustomButton"
                        ...
                    />
                </TextBox>
            );
        }
    }
    export default App;

rtlEnabled

Switches the widget to a right-to-left representation.

Type:

Boolean

Default Value: false

When this option is set to true, the widget text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

JavaScript
DevExpress.config({
    rtlEnabled: true
});
See Also

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.

showMaskMode

Specifies when the widget shows the mask. Applies only if useMaskedValue is true.

Type:

String

Default Value: 'always'
Accepted Values: 'always' | 'onFocus'

spellcheck

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

Type:

Boolean

Default Value: false

stylingMode

Specifies how the widget's text field is styled.

Type:

String

Default Value: 'outlined', 'underlined' (Material)
Accepted Values: 'outlined' | 'underlined' | 'filled'

The following styles are available:

Text Editor Styling Modes

Use the EditorStylingMode enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Outlined, Underlined, and Filled.

You can also use the global editorStylingMode setting to specify how the text fields of all editors in your application are styled.

tabIndex

Specifies the number of the element when the Tab key is used for navigating.

Type:

Number

Default Value: 0

The value of this option will be passed to the tabindex attribute of the HTML element that underlies the widget.

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.

validationError

Specifies information on the validation error when using a custom validation engine. Should be changed at runtime along with the isValid option.

Type:

Object

Default Value: undefined

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: 'always' | 'auto'

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.

Use the ValidationMessageMode enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Auto and Always.

value

Specifies a value the widget displays.

Type:

String

Default Value: ''
Raised Events: onValueChanged

valueChangeEvent

Specifies the DOM events after which the widget's value should be updated.

Type:

String

Default Value: 'change'

This option accepts a single event name or several names separated by spaces.

The recommended events are "keyup", "blur", "change", and "focusout", but you can use other events as well.

visible

Specifies whether the widget is visible.

Type:

Boolean

Default Value: true

width

Specifies the widget's width.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The widget's width.

Default Value: undefined

This option accepts a value of one of the following types:

  • Number
    The width in pixels.

  • String
    A CSS-accepted measurement of width. For example, "55px", "80%", "auto", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    width: function() {
        return window.innerWidth / 1.5;
    }