Configuration

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:

Default Value: false

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

disabled

Specifies whether the widget responds to user interaction.

Type:

Default Value: false

elementAttr

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

Type:

Default Value: {}

jQuery

$(function(){
    $("#numberBoxContainer").dxNumberBox({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});

Angular

HTML

TypeScript

<dx-number-box ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-number-box>

import { DxNumberBoxModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxNumberBoxModule
    ],
    // ...
})

ASP.NET MVC Control

Razor C#

Razor VB

@(Html.DevExtreme().NumberBox()
    .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().NumberBox() _
    .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:

Default Value: true

format

Specifies the value's display format and controls user input accordingly.

Type:

Format

Default Value: ''

NOTE

With this option specified, a press on Minus Sign (-) inverts the current value instead of entering "-".

NOTE

If you set this option, the telephone keyboard is used for editing on mobile devices. However, it may not have a point, comma, or other symbols for entering decimals. Set the mode option to "text" to use the standard keyboard instead.

View Demo

height

Specifies the widget's height.

Type:

|

|

Return Value:

|

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%", "auto", "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:

Default Value: undefined

hoverStateEnabled

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

Type:

Default Value: true

inputAttr

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

Type:

Default Value: {}

jQuery

$(function(){
    $("#numberBoxContainer").dxNumberBox({
        // ...
        inputAttr: {
            id: "inputId"
        }
    });
});

Angular

HTML

TypeScript

<dx-number-box ...
    [inputAttr]="{ id: 'inputId' }">
</dx-number-box>

import { DxNumberBoxModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxNumberBoxModule
    ],
    // ...
})

ASP.NET MVC Control

Razor C#

Razor VB

@(Html.DevExtreme().NumberBox()
    .InputAttr("id", "inputId")
    // ===== or =====
    .InputAttr(new {
        @id = "inputId"
    })
    // ===== or =====
    .InputAttr(new Dictionary<string, object>() {
        { "id", "inputId" }
    })
)

@(Html.DevExtreme().NumberBox() _
    .InputAttr("id", "inputId")
    ' ===== or =====
    .InputAttr(New With {
        .id = "inputId"
    })
    ' ===== or =====
    .InputAttr(New Dictionary(Of String, Object) From {
        { "id", "inputId" }
    })
)

invalidValueMessage

Specifies the text of the message displayed if the specified value is not a number.

Type:

Default Value: 'Value must be a number'

isValid

Specifies whether the editor's value is valid.

Type:

Default Value: true

max

The maximum value accepted by the number box.

Type:

Default Value: undefined

min

The minimum value accepted by the number box.

Type:

Default Value: undefined

mode

Specifies the value to be passed to the type attribute of the underlying <input> element.

Type:

Default Value: 'text', 'number' (mobile devices)

Accepted Values: 'number' | 'text' | 'tel'

NOTE

If you set the format option, the mode for mobile devices is changed to "tel"; "number" is not available.

Use the NumberBoxMode enum to specify this option when the widget is used as an ASP.NET MVC Control. This enum accepts the following values: Text, Number, and Tel.

name

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

Type:

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 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 parameters:

e:

Information about the event.

Object structure:

component:

The widget's instance.

element:

Element (jQuery or HTML)

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

model:

The model data. Available only if Knockout is used.

jQueryEvent:

Use 'event' instead.

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

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

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 parameters:

e:

Information about the event.

Object structure:

component:

The widget's instance.

element:

Element (jQuery or HTML)

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

model:

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 parameters:

e:

Information about the event.

Object structure:

component:

The widget's instance.

element:

Element (jQuery or HTML)

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

model:

The model data. Available only if Knockout is used.

jQueryEvent:

Use 'event' instead.

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

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

onCut

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

Type:

Function parameters:

e:

Information about the event.

Object structure:

component:

The widget's instance.

element:

Element (jQuery or HTML)

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

model:

The model data. Available only if Knockout is used.

jQueryEvent:

Use 'event' instead.

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

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

onDisposing

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

Type:

Function parameters:

e:

Information about the event.

Object structure:

component:

The widget's instance.

element:

Element (jQuery or HTML)

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

model:

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 parameters:

e:

Information about the event.

Object structure:

component:

The widget's instance.

element:

Element (jQuery or HTML)

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

model:

The model data. Available only if Knockout is used.

jQueryEvent:

Use 'event' instead.

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

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

onFocusIn

A function that is executed when the widget gets focus.

Type:

Function parameters:

e:

Information about the event.

Object structure:

component:

The widget's instance.

element:

Element (jQuery or HTML)

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

model:

The model data. Available only if Knockout is used.

jQueryEvent:

Use 'event' instead.

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

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

onFocusOut

A function that is executed when the widget loses focus.

Type:

Function parameters:

e:

Information about the event.

Object structure:

component:

The widget's instance.

element:

Element (jQuery or HTML)

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

model:

The model data. Available only if Knockout is used.

jQueryEvent:

Use 'event' instead.

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

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

onInitialized

A function that is executed only once, after the widget is initialized.

Type:

Function parameters:

e:

Information about the event.

Object structure:

component:

The widget's instance.

element:

Element (jQuery or HTML)

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

Default Value: null

You cannot access widget elements in this function because it is executed before they are ready. Use the onContentReady function instead.

onInput

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

Type:

Function parameters:

e:

Information about the event.

Object structure:

component:

The widget's instance.

element:

Element (jQuery or HTML)

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

model:

The model data. Available only if Knockout is used.

jQueryEvent:

Use 'event' instead.

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

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

onKeyDown

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

Type:

Function parameters:

e:

Information about the event.

Object structure:

component:

The widget's instance.

element:

Element (jQuery or HTML)

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

model:

The model data. Available only if Knockout is used.

jQueryEvent:

Use 'event' instead.

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

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

onKeyPress

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

Type:

Function parameters:

e:

Information about the event.

Object structure:

component:

The widget's instance.

element:

Element (jQuery or HTML)

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

model:

The model data. Available only if Knockout is used.

jQueryEvent:

Use 'event' instead.

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

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

onKeyUp

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

Type:

Function parameters:

e:

Information about the event.

Object structure:

component:

The widget's instance.

element:

Element (jQuery or HTML)

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

model:

The model data. Available only if Knockout is used.

jQueryEvent:

Use 'event' instead.

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

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

onOptionChanged

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

Type:

Function parameters:

e:

Information about the event.

Object structure:

component:

The widget's instance.

name:

The option's short name.

fullName:

The option's full name.

value: any

The option's new value.

element:

Element (jQuery or HTML)

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

model:

The model data. Available only if you use Knockout.

Default Value: null

onPaste

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

Type:

Function parameters:

e:

Information about the event.

Object structure:

component:

The widget's instance.

element:

Element (jQuery or HTML)

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

model:

The model data. Available only if Knockout is used.

jQueryEvent:

Use 'event' instead.

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

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

onValueChanged

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

Type:

Function parameters:

e:

Information about the event.

Object structure:

component:

The widget's instance.

element:

Element (jQuery or HTML)

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

model:

The model data. Available only if Knockout is used.

value:

The widget's new value.

previousValue:

The widget's previous value.

jQueryEvent:

Use 'event' instead.

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

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

placeholder

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

Type:

Default Value: ''

readOnly

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

Type:

Default Value: false

rtlEnabled

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

Type:

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
});

showClearButton

Specifies whether to display the Clear button in the widget.

Type:

Default Value: false

The Clear button sets the widget value to null.

showSpinButtons

Specifies whether to show the buttons that change the value by a step.

Type:

Default Value: false

step

Specifies how much the widget's value changes when using the spin buttons, Up/Down arrow keys, or mouse wheel.

Type:

Default Value: 1

stylingMode

Specifies how the widget's text field is styled.

Type:

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 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:

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:

Read-only

useLargeSpinButtons

Specifies whether to use touch friendly spin buttons. Applies only if showSpinButtons is true.

Type:

Default Value: true, false (desktop)

validationError

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

Type:

Default Value: undefined

validationMessageMode

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

Type:

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 Control. This enum accepts the following values: Auto and Always.

value

The current number box value.

Type:

Default Value: 0

valueChangeEvent

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

Type:

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: