React Box Methods
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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 Box UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxBox.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Box options } });
Angular
import Box from "devextreme/ui/box"; // ... export class AppComponent { constructor () { Box.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Box options } }); } }
Vue
<template> <div> <DxBox id="box1" /> <DxBox id="box2" /> </div> </template> <script> import DxBox from "devextreme-vue/box"; import Box from "devextreme/ui/box"; Box.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Box options } }); export default { components: { DxBox } } </script>
React
import React from "react"; import dxBox from "devextreme/ui/box"; import Box from "devextreme-react/box"; class App extends React.Component { render () { dxBox.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Box options } }) return ( <div> <Box id="box1" /> <Box id="box2" /> </div> ) } } export default App;
dispose()
After calling this method, remove the DOM element associated with the UI component:
$("#myBox").dxBox("dispose"); $("#myBox").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-box ... *ngIf="condition"> </dx-box>
Vue
<template> <DxBox ... v-if="condition"> </DxBox> </template> <script> import DxBox from 'devextreme-vue/box'; export default { components: { DxBox } } </script>
React
import React from 'react'; import Box from 'devextreme-react/box'; function DxBox(props) { if (!props.shouldRender) { return null; } return ( <Box ... > </Box> ); } class App extends React.Component { render() { return ( <DxBox 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
getDataSource()
Gets the DataSource instance.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- Data Layer - Overview
- Data Layer - DataSource Examples
getInstance(element)
getInstance is a static method that the UI component class supports. The following code demonstrates how to get the Box instance found in an element with the myBox
ID:
// Modular approach import Box from "devextreme/ui/box"; ... let element = document.getElementById("myBox"); let instance = Box.getInstance(element) as Box; // Non-modular approach let element = document.getElementById("myBox"); let instance = DevExpress.ui.dxBox.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
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
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.