Configuration

An object defining configuration options for the dxDateBox widget.

applyValueMode

Specifies the way an end-user applies the selected value.

Type: String
Default Value: "instantly"
Accepted Values: 'useButtons'|'instantly'

The option accepts the following values.

  • 'useButtons'
    Enables an end-user to apply the selected value or cancel the selection using the Apply and Cancel buttons respectively.

  • 'instantly'
    Applies the selected value immediately after a user clicks the required value in the drop-down menu. To cancel the selection, click outside the drop-down menu.

Show Example:
AngularJS
Knockout
jQuery

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.

closeOnValueChange

Deprecated

Use the applyValueMode option instead.

copyAction

Deprecated

Use the onCopy option instead.

cutAction

Deprecated

Use the onCut option instead.

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

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

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

format

A format used to display date/time information.

Type: String
Default Value: "date"
Accepted Values: 'date'|'time'|'datetime'

You can assign the following values to this option:

  • date - the widget displays only the date;
  • time - the widget displays only the time;
  • datetime - the widget displays both the date and the time.
Show Example:
AngularJS
Knockout
jQuery

formatString

A Globalize format string specifying the date display format.

Type: String
Default Value: "d"

This option accepts custom date and time format strings.

This option makes sense if the useCalendar option is set to 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.

interval

Specifies the interval between neighboring values in the popup list in minutes.

Type: Number
Default Value: 30

This option makes sense if the format option is set to "time" and the useCalendar option value is set to true.

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.

keyDownAction

Deprecated

Use the onKeyDown option instead.

keyPressAction

Deprecated

Use the onKeyPress option instead.

keyUpAction

Deprecated

Use the onKeyUp option instead.

max

The last date that can be selected within the widget.

Type: Date
Default Value: undefined

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.

min

The minimum date that can be selected within the widget.

Type: Date
Default Value: undefined

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.

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.

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.

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

openAction

Deprecated

Use the onOpened option instead.

opened

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

Type: Boolean
Default Value: false

pasteAction

Deprecated

Use the onPaste option instead.

placeholder

The text displayed by the widget when the widget value is not yet specified. This text is also used as a title of the date picker.

Type: String
Default Value: ""

The placeholder option has the following default values depending on the format option value.

  • "date" - the default value is "Select date"
  • "time" - the default value is "Select time"
  • "datetime" - the default value is "Select date and time"

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.

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.

NOTE: The Clear button is displayed if the useNative option is set to false. Otherwise, the Clear button is displayed only if the native widget implementation includes it.

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

useCalendar

Specifies whether or not a user can pick out a date using the drop-down calendar.

Type: Boolean
Default Value: false
Default for generic: true

This option makes sense only if the format option is set to "date".

If the useCalendar option is set to true, the widget uses the simulated date box regardless the useNative option value.

Show Example:
AngularJS
Knockout
jQuery

useNative

Specifies whether or not the widget uses the native HTML input element.

Type: Boolean
Default Value: true

NOTE: The widget can use native input elements only if the useCalendar option is disabled. If the useCalendar option is set to true, the widget always uses the simulated date box regardless of the useNative option value.

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

A Date object specifying the date and time currently selected using the date box.

Type: Date
Default Value: new Date()

valueChangeAction

Deprecated

Use the onValueChanged option instead.

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.

valueUpdateAction

Deprecated

Use the onValueChanged option instead.

valueUpdateEvent

Deprecated

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