DateBox 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 the widget is clicked.

Type: Action
Default Value: null

Show Example:
jQuery
<div class="dx-fieldset">
    <div class="dx-field">
        <div class="dx-field-label">Date and Time</div>
        <div class="dx-field-value" data-bind="
  dxDateBox: { format: 'datetime', clickAction: processClick }"></div>  
    </div>
</div>
processClick = function () {
  DevExpress.ui.notify("The widget has been clicked", "info", 1000);
}

disabled

A Boolean value specifying whether or not a component 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 component at runtime.

Show Example:
jQuery
<div class="dateBox" data-bind="dxDateBox: { disabled: dateBoxDisabled }"></div><br/>
<div class="dx-fieldset">
  <div class="dx-field">
    <div class="dx-field-label">Disabled</div>
    <div class="dx-field-value" data-bind="dxCheckBox: { checked: dateBoxDisabled }"></div>
  </div>
</div>
dateBoxDisabled = ko.observable(false);
body{
  text-align: center;
}
.dateBox{
  margin: 10px;
}

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
<div class="dateBox" data-bind="dxDateBox: { format: dateBoxFormat }"></div><br/>
<div class="dx-fieldset">
  <div class="dx-field">
    <div class="dx-field-label">Format</div>
    <div class="dx-field-value" data-bind="dxLookup: { dataSource: dateBoxFormats, value: dateBoxFormat }"></div>
  </div>
</div>
dateBoxFormats = [
  "date",
  "time",
  "datetime"
];
dateBoxFormat = ko.observable(dateBoxFormats[0]);
body{
  text-align: center;
}
.dateBox{
  margin: 10px;
}

height

Specifies the height of the widget.

Type: Number|String|function
Default Value: undefined

The option can hold a value of the following types:

  • 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: Object
Default Value: new Date()

valueUpdateAction

An action performed when the widget value is updated.

Type: Action
Default Value: null

valueUpdateEvent

Specifies DOM event names that cause the widget value to update.

Type: String
Default Value: "change"

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