JavaScript/jQuery DateBox Methods
beginUpdate()
Prevents the UI component from refreshing until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods prevent the UI component from excessive updates when you are changing multiple UI component settings at once. After the beginUpdate() method is called, the UI component does not update its UI until the endUpdate() method is called.
See Also
defaultOptions(rule)
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 from "devextreme/ui/date_box";
// ...
export class AppComponent {
constructor () {
DateBox.defaultOptions({
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 React, {useEffect} from "react";
import dxDateBox from "devextreme/ui/date_box";
import DateBox from "devextreme-react/date-box";
export default function App() {
useEffect(() => {
dxDateBox.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the DateBox properties
}
})
});
return (
<div>
<DateBox id="dateBox1" />
<DateBox id="dateBox2" />
</div>
)
}dispose()
After calling this method, remove the DOM element associated with the UI component:
$("#myDateBox").dxDateBox("dispose");
$("#myDateBox").remove();Use this method only if the UI component was created with jQuery or pure JavaScript. In Angular, Vue, and React, use conditional rendering:
Angular
<dx-date-box ...
*ngIf="condition">
</dx-date-box>Vue
<template>
<DxDateBox ...
v-if="condition">
</DxDateBox>
</template>
<script>
import DxDateBox from 'devextreme-vue/date-box';
export default {
components: {
DxDateBox
}
}
</script>React
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;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
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.