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
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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 CheckBox UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxCheckBox.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the CheckBox options } });
Angular
import CheckBox from "devextreme/ui/check_box"; // ... export class AppComponent { constructor () { CheckBox.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the CheckBox options } }); } }
Vue
<template> <div> <DxCheckBox id="checkBox1" /> <DxCheckBox id="checkBox2" /> </div> </template> <script> import DxCheckBox from "devextreme-vue/check-box"; import CheckBox from "devextreme/ui/check_box"; CheckBox.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the CheckBox options } }); export default { components: { DxCheckBox } } </script>
React
import React from "react"; import dxCheckBox from "devextreme/ui/check_box"; import CheckBox from "devextreme-react/check-box"; class App extends React.Component { render () { dxCheckBox.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the CheckBox options } }) return ( <div> <CheckBox id="checkBox1" /> <CheckBox id="checkBox2" /> </div> ) } } export default App;
dispose()
After calling this method, remove the DOM element associated with the UI component:
$("#myCheckBox").dxCheckBox("dispose"); $("#myCheckBox").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-check-box ... *ngIf="condition"> </dx-check-box>
Vue
<template> <DxCheckBox ... v-if="condition"> </DxCheckBox> </template> <script> import DxCheckBox from 'devextreme-vue/check-box'; export default { components: { DxCheckBox } } </script>
React
import React from 'react'; import CheckBox from 'devextreme-react/check-box'; function DxCheckBox(props) { if (!props.shouldRender) { return null; } return ( <CheckBox ... > </CheckBox> ); } class App extends React.Component { render() { return ( <DxCheckBox shouldRender="condition" /> ); } } export default App;
See Also
element()
An HTML element or a jQuery element when you use jQuery.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
endUpdate()
Refreshes the UI component after a call of the beginUpdate() method.
Main article: beginUpdate()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
focus()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
getInstance(element)
getInstance is a static method that the UI component class supports. The following code demonstrates how to get the CheckBox instance found in an element with the myCheckBox
ID:
// Modular approach import CheckBox from "devextreme/ui/check_box"; ... let element = document.getElementById("myCheckBox"); let instance = CheckBox.getInstance(element) as CheckBox; // Non-modular approach let element = document.getElementById("myCheckBox"); let instance = DevExpress.ui.dxCheckBox.getInstance(element);
See Also
instance()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName)
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName, eventHandler)
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
on(eventName, eventHandler)
Use this method to subscribe to one of the events listed in the Events section.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
on(events)
Use this method to subscribe to several events with one method call. Available events are listed in the Events section.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option()
Gets all UI component properties.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName)
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName, optionValue)
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(options)
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
registerKeyHandler(key, handler)
A handler. Accepts the keydown event as the argument. It is a dxEvent 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
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
repaint()
See Also
- reload() in DataSource | List
- refresh() in DataGrid | TreeList
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
reset()
Resets the value property to the default value.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
resetOption(optionName)
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
If you have technical questions, please create a support ticket in the DevExpress Support Center.