JavaScript/jQuery DateBox Methods

The component's default device options.

Object structure:

Name	Type	Description
device	Device \| Array<Device> \| Function	Device parameters. When specifying a function, get information about the current device from the argument. Return true if the options should be applied to the device.
options	Object	Options to be applied.

Name

Type

Description

device

Device

|

Array<Device>

|

Device parameters.
When specifying a function, get information about the current device from the argument. Return true if the options should be applied to the device.

options

Options to be applied.

defaultOptions is a static method that the widget class supports. The following code demonstrates how to specify default options for all instances of the DateBox widget in an application executed on the desktop.

jQuery

JavaScript

DevExpress.ui.dxDateBox.defaultOptions({ 
    device: { deviceType: "desktop" },
    options: {
        // Here go the DateBox options
    }
});

Angular

TypeScript

import DateBox from 'devextreme/ui/date_box';
// ...
export class AppComponent {
    constructor () {
        DateBox.defaultOptions({
            device: { deviceType: "desktop" },
            options: {
                // Here go the DateBox options
            }
        });
    }
}

dispose()

Disposes of all the resources allocated to the DateBox instance.

The following code disposes of an DateBox instance that corresponds to the element ID (or reference variable in Angular) and removes the element from the DOM:

jQuery

JavaScript

$("#myDateBox").dxDateBox("dispose");
$("#myDateBox").remove();

Angular

HTML

<dx-date-box #dateBoxVar id="myDateBox"></dx-date-box>

TypeScript

import { ..., ViewChild } from "@angular/core";
import { DxDateBoxComponent } from "devextreme-angular";
// ...
export class AppComponent {
    @ViewChild("dateBoxVar") dateBox: DxDateBoxComponent;

    removeDateBox (e) {
        this.dateBox.instance.dispose();
        document.getElementById("myDateBox").remove();
    }
}

element()

Gets the root widget element.

Return Value:

HTMLElement | jQuery

An HTML element or a jQuery element when you use jQuery.

endUpdate()

Refreshes the widget after a call of the beginUpdate() method.

Main article: beginUpdate()

field()

Gets the widget's <input> element.

Return Value:

HTMLElement | jQuery

An HTML element or a jQuery element when you use jQuery.

focus()

Sets focus to the input element representing the widget.

NOTE

In the mobile Safari browser, it is impossible to set focus programmatically. You can find more information about this here. You can, however, accomplish this task using PhoneGap when building a native package. Set the KeyboardDisplayRequiresUserAction preference to false in the config.xml file with Cordova settings.

After that, the focus() method will work as follows.

getInstance(element)

Gets the instance of a widget found using its DOM node.

Parameters:

element:

DOM Node

|

jQuery

The widget's container.

Return Value:

The widget's instance.

getInstance is a static method that the widget class supports. The following code demonstrates how to get the DateBox instance found in an element with the myDateBox ID:

// Modular approach
import DateBox from 'devextreme/ui/date_box';
...
let element = document.getElementById("myDateBox");
let instance = DateBox.getInstance(element) as DateBox;

// Non-modular approach
let element = document.getElementById("myDateBox");
let instance = DevExpress.ui.dxDateBox.getInstance(element);

instance()

Gets the widget's instance. Use it to access other methods of the widget.

Return Value:

This widget's instance.

off(eventName)

Detaches all event handlers from a single event.

Parameters:

eventName:

The event's name.

Return Value:

The object for which this method is called.

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:

eventName:

The event's name.

eventHandler:

The event's handler.

Return Value:

The object for which this method is called.

on(eventName, eventHandler)

Subscribes to an event.

Parameters:

eventName:

The event's name.

eventHandler:

The event's handler.

Return Value:

The object for which this method is called.

Use this method to subscribe to one of the events listed in the Events section.

on(events)

Subscribes to events.

Parameters:

events:

Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}

Return Value:

The object for which this method is called.

Use this method to subscribe to several events with one method call. Available events are listed in the Events section.

open()

Opens the drop-down editor.

option()

Gets all widget options.

Return Value:

The widget's options.

option(optionName)

Gets the value of a single option.

Parameters:

optionName:

The option's name or full path.

Return Value: any

This option's value.

option(optionName, optionValue)

Updates the value of a single option.

Parameters:

optionName:

The option's name or full path.

optionValue: any

This option's new value.

option(options)

Updates the values of several options.

Parameters:

options:

Options with their new values.

registerKeyHandler(key, handler)

Registers a handler to be executed when a user presses a specific key.

Parameters:

key:

The key.

handler: