DateBox

A date box widget.

Included in: dx.phonejs.js, dx.webappjs.js, dx.all.js

The dxDateBox widget displays the date and time value in a specified format, and enables a user to pick the required date/time value.

You can create a widget using one of the following approaches.

  • jQuery
    Use the dxDateBox jQuery plug-in.

    HTML
    <div id="dateBox"></div>
    JavaScript
    $("#dateBox").dxDateBox({
        min: new Date(2000,0,1),
        max: new Date(2029,11,31),
        value: new Date()
    });
  • Knockout
    Add a div element and apply the dxDateBox binding to this element.

    JavaScript
    var myViewModel = {
        minDate: new Date(2000,0,1),
        maxDate: new Date(2029,11,31),
        currentValue: new Date()
    }
    ko.applyBindings(myViewModel);
    HTML
    <div data-bind="dxDateBox: {
        min: minDate,
        max: maxDate,
        value: currentValue
    }"></div>
  • Angular
    Add a div element and apply the dx-date-box directive to this element.

    JavaScript
    var myApp = angular.module('myApp', ['dx']);
    myApp.controller("demoController", function ($scope) {
        $scope.minDate = new Date(2000,0,1);
        $scope.maxDate = new Date(2029,11,31);
        $scope.currentValue = new Date();
    });
    angular.element(document).ready(function () {
        angular.bootstrap(document, ['myApp']);
    });
    HTML
    <div dx-date-box="{
        min: minDate,
        max: maxDate,
        bindingOptions: {
            value: 'currentValue'
        }
    }"></div>

Note that DevExtreme widgets require you to link the jQuery and Globalize libraries to your application. If you use the Knockout or Angular approach, the Knockout or Angular library is also required.

See Also

You can find detailed information on principles of working with the widget in the dxDateBox section of the Editor Widgets article.

View Demo

Configuration

An object defining configuration options for the dxDateBox widget.

Name Description
accessKey

Specifies a shortcut key that sets focus on the widget element.

activeStateEnabled

A Boolean value specifying whether or not the widget changes its state when interacting with a user.

applyButtonText

The text displayed on the Apply button.

applyValueMode

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

attr

Specifies HTML attributes applied to the inner input element of the widget.

cancelButtonText

The text displayed on the Cancel button.

dataSource

A data source used to fetch data to be displayed by the widget.

deferRendering

Specifies whether widget content is rendered when the widget is shown or when rendering the widget.

disabled

A Boolean value specifying whether or not the widget can respond to user interaction.

fieldEditEnabled

Specifies whether or not the widget allows an end-user to enter a custom value.

focusStateEnabled

Specifies whether or not the widget supports the focused state and keyboard navigation.

format

A format used to display date/time information.

formatString

A Globalize format string specifying the date display format.

height

Specifies the height of the widget.

hint

Specifies the text of the hint displayed for the widget.

hoverStateEnabled

A Boolean value specifying whether or not the widget changes its state when being hovered by an end user.

interval

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

isValid

Specifies whether the editor's value is valid.

max

The last date that can be selected within the widget.

maxLength

Specifies the maximum number of characters you can enter into the textbox.

maxZoomLevel

Specifies the maximum zoom level of a calendar, which is used to pick the date.

min

The minimum date that can be selected within the widget.

minZoomLevel

Specifies the minimal zoom level of a calendar, which is used to pick the date.

onChange

A handler for the change event.

onClosed

A handler for the closed event.

onCopy

A handler for the copy event.

onCut

A handler for the cut event.

onDisposing

A handler for the disposing event.

onEnterKey

A handler for the enterKey event.

onFocusIn

A handler for the focusIn event.

onFocusOut

A handler for the focusOut event.

onInitialized

A handler for the initialized event.

onInput

A handler for the input event.

onKeyDown

A handler for the keyDown event.

onKeyPress

A handler for the keyPress event.

onKeyUp

A handler for the keyUp event.

onOpened

A handler for the opened event.

onOptionChanged

A handler for the optionChanged event.

onPaste

A handler for the paste event.

onValueChanged

A handler for the valueChanged event.

opened

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

pickerType

Specifies the type of date/time picker.

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.

readOnly

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

rtlEnabled

Specifies whether or not the current component supports a right-to-left representation.

showClearButton

Specifies whether or not to display the Clear button in the widget.

spellcheck

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

tabIndex

Specifies the widget tab index.

text

The read-only option that holds the text displayed by the widget input element.

validationError

Holds the object that defines the error that occurred during validation.

validationMessageMode

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

value

An object or a value, specifying the date and time currently selected using the date box.

valueChangeEvent

Specifies DOM event names that update a widget's value.

visible

A Boolean value specifying whether or not the widget is visible.

width

Specifies the width of the widget.

Methods

This section describes members used to manipulate the widget.

Name Description
beginUpdate()

Prevents the component from refreshing until the endUpdate method is called.

blur()

Removes focus from the input element.

close()

Closes the drop-down editor.

content()

Returns an HTML element of the popup window content.

defaultOptions(rule)

Specifies the device-dependent default configuration options for this component.

element()

Returns the root HTML element of the widget.

endUpdate()

Enables the component to refresh after the beginUpdate method call.

field()

Returns an <input> element of the widget.

focus()

Sets focus to the input element representing the widget.

instance()

Returns an instance of this component class.

off(eventName)

Detaches all event handlers from the specified event.

off(eventName, eventHandler)

Detaches a particular event handler from the specified event.

on(eventName, eventHandler)

Subscribes to a specified event.

on(events)

Subscribes to the specified events.

open()

Opens the drop-down editor.

option()

Returns the configuration options of this component.

option(optionName)

Gets the value of the specified configuration option of this component.

option(optionName, optionValue)

Sets a value to the specified configuration option of this component.

option(options)

Sets one or more options of this component.

registerKeyHandler(key, handler)

Registers a handler when a specified key is pressed.

repaint()

Redraws the widget.

reset()

Resets the widget's value to null.

Events

This section describes events exposed by this widget.

Name Description
change

Fires when a change within the widget's input element is committed by an end user.

closed

Fires after a drop-down list has been hidden.

copy

Fires after the widget's input has been copied.

cut

Fires after the Cut DOM event has fired.

disposing

Fires when the widget is being removed.

enterKey

Fires after a key has been entered within the widget's input element.

focusIn

Fires after the widget's input has been focused.

focusOut

Fires after the widget's input element has lost focus.

initialized

Fires when the widget is initialized.

input

Fires when a value within the widget's input element is changed by an end user.

keyDown

Fires when a key is pressed down within the widget's input element.

keyPress

Fires when the keypress DOM event has been raised for the current input element.

keyUp

Fires when a key is released within the widget's input element.

opened

Fires when the drop-down editor is shown.

optionChanged

Fires after an option of the component is changed.

paste

Fires after the widget's input has been pasted.

valueChanged

Fires when the editor value changes.