JavaScript/jQuery DateBox Methods
beginUpdate()
Postpones rendering that can negatively affect performance until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
defaultOptions(rule)
Name | Type | Description |
---|---|---|
device | | |
Device parameters. |
options |
Options to be applied. |
defaultOptions is a static method that the UI component class supports. The following code demonstrates how to specify default properties for all instances of the DateBox UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxDateBox.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the DateBox properties } });
Angular
import DateBox, { Properties } from "devextreme/ui/date_box"; // ... export class AppComponent { constructor () { DateBox.defaultOptions<Properties>({ device: { deviceType: "desktop" }, options: { // Here go the DateBox properties } }); } }
Vue
<template> <div> <DxDateBox id="dateBox1" /> <DxDateBox id="dateBox2" /> </div> </template> <script> import DxDateBox from "devextreme-vue/date-box"; import DateBox from "devextreme/ui/date_box"; DateBox.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the DateBox properties } }); export default { components: { DxDateBox } } </script>
React
import dxDateBox from "devextreme/ui/date_box"; import DateBox from "devextreme-react/date-box"; dxDateBox.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the DateBox properties } }); export default function App() { return ( <div> <DateBox id="dateBox1" /> <DateBox id="dateBox2" /> </div> ) }
You can also set rules for multiple device types:
jQuery
const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { DevExpress.ui.dxDateBox.defaultOptions({ device: deviceConfig, options: { // Here go the DateBox properties } }); });
Angular
import DateBox, { Properties } from "devextreme/ui/date_box"; // ... export class AppComponent { constructor () { const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { DateBox.defaultOptions<Properties>({ device: deviceConfig, options: { // Here go the DateBox properties } }); }); } }
Vue
<template> <div> <DxDateBox /> </div> </template> <script> import DxDateBox from "devextreme-vue/date-box"; import DateBox from "devextreme/ui/date_box"; const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { DateBox.defaultOptions({ device: deviceConfig, options: { // Here go the DateBox properties } }); }); export default { components: { DxDateBox } } </script>
React
import dxDateBox from "devextreme/ui/date_box"; import DateBox from "devextreme-react/date-box"; const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { dxDateBox.defaultOptions({ device: deviceConfig, options: { // Here go the DateBox properties } }); }); export default function App() { return ( <div> <DateBox /> </div> ) }
dispose()
jQuery
After calling this method, remove the DOM element associated with the UI component:
$("#myDateBox").dxDateBox("dispose"); $("#myDateBox").remove();
Angular
Use conditional rendering instead of this method:
<dx-date-box ... *ngIf="condition"> </dx-date-box>
Vue
Use conditional rendering instead of this method:
<template> <DxDateBox ... v-if="condition"> </DxDateBox> </template> <script> import DxDateBox from 'devextreme-vue/date-box'; export default { components: { DxDateBox } } </script>
React
Use conditional rendering instead of this method:
import React from 'react'; import DateBox from 'devextreme-react/date-box'; function DxDateBox(props) { if (!props.shouldRender) { return null; } return ( <DateBox ... > </DateBox> ); } class App extends React.Component { render() { return ( <DxDateBox shouldRender="condition" /> ); } } export default App;
endUpdate()
Refreshes the UI component after a call of the beginUpdate() method.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
getButton(name)
Gets an instance of a custom action button.
Use the returned button instance to call the Button UI component's methods, for example, focus():
jQuery
const myCustomButton = $("#dateBoxContainer").dxDateBox("getButton", "myCustomButton"); myCustomButton.focus();
Angular
import { Component, ViewChild } from '@angular/core'; import { DxDateBoxComponent } from 'devextreme-angular'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { @ViewChild('dateBoxRef', { static: false }) dateBox: DxDateBoxComponent; // Prior to Angular 8 // @ViewChild('dateBoxRef') dateBox: DxDateBoxComponent; setFocus() { this.dateBox.instance.getButton('myCustomButton').focus(); } }
<dx-date-box #dateBoxRef ... > </dx-date-box>
Vue
<template> <DxDateBox ... :ref="dateBoxRef"> </DxDateBox> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxDateBox from 'devextreme-vue/date-box'; export default { components: { DxDateBox }, data() { return { dateBoxRef } }, methods: { setFocus() { this.dateBox.getButton('myCustomButton').focus(); } }, computed: { dateBox: function() { return this.$refs[dateBoxRef].instance; } } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import DateBox from 'devextreme-react/date-box'; class App extends React.Component { constructor(props) { super(props); this.dateBoxRef = React.createRef(); this.setFocus = () => { this.dateBox.getButton('myCustomButton').focus(); }; } get dateBox() { return this.dateBoxRef.current.instance(); } render() { return ( <DateBox ... ref={this.dateBoxRef}> </DateBox> ); } } export default App;
getInstance(element)
getInstance is a static method that the UI component 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);
See Also
on(eventName, eventHandler)
Use this method to subscribe to one of the events listed in the Events section.
See Also
on(events)
Use this method to subscribe to several events with one method call. Available events are listed in the Events section.
See Also
registerKeyHandler(key, handler)
A handler. Accepts the keydown event as the argument. It is a EventObject or a jQuery.Event when you use jQuery.
The key argument accepts one of the following values:
- "backspace"
- "tab"
- "enter"
- "escape"
- "pageUp"
- "pageDown"
- "end"
- "home"
- "leftArrow"
- "upArrow"
- "rightArrow"
- "downArrow"
- "del"
- "space"
- "F"
- "A"
- "asterisk"
- "minus"
A custom handler for a key cancels the default handler for this key.
See Also
repaint()
Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically.
The repaint()
method re-initializes the component with new settings, resetting its state and history.
See Also
- reload() in DataSource | List
- refresh() in DataGrid | TreeList