Configuration

An object defining configuration options for the dxDateBox widget.

changeAction

An action performed on the 'change' event of the input element representing the widget.

Type: Action
Default Value: null

clickAction

An action performed when a widget is clicked.

Type: Action
Default Value: null

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

enterKeyAction

An action performed when the Enter key is pressed, provided that the widget is focused.

Type: Action
Default Value: null

focusInAction

An action performed on the 'focusin' event of the input element representing the widget.

Type: Action
Default Value: null

focusOutAction

An action performed on the 'focusout' event of the input element representing the widget.

Type: Action
Default Value: null

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

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 the following types of values.

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

keyDownAction

An action performed on the 'keydown' event of the input element representing the widget.

Type: Action
Default Value: null

keyPressAction

An action performed on the 'keypress' event of the input element representing the widget.

Type: Action
Default Value: null

keyUpAction

An action performed on the 'keyup' event of the input element representing the widget.

Type: Action
Default Value: null

placeholder

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

Type: String
Default Value: ""

readOnly

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

Type: Boolean
Default Value: false

value

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

Type: Date
Default Value: new Date()

valueUpdateAction

An action performed when the widget value is updated.

Type: Action
Default Value: null

An object passed to the action function assigned to this option can have the value field in addition to the basic field set. This field contains the new widget value.

valueUpdateEvent

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. You can assign any DOM event names to this option. For example, "change", "blur", "input", "keyup", etc.

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 the following types of values.

  • 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 (e.g., width:function(){ return baseWidth - 10 + "%"; })