JavaScript/jQuery Toolbar Methods
This section describes members used to manipulate the UI component.
See Also
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)
Specifies the device-dependent default configuration properties for this component.
The component's default device properties.
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 Toolbar UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxToolbar.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Toolbar properties } });
Angular
import Toolbar, { Properties } from "devextreme/ui/toolbar"; // ... export class AppComponent { constructor () { Toolbar.defaultOptions<Properties>({ device: { deviceType: "desktop" }, options: { // Here go the Toolbar properties } }); } }
Vue
<template> <div> <DxToolbar id="toolbar1" /> <DxToolbar id="toolbar2" /> </div> </template> <script> import DxToolbar from "devextreme-vue/toolbar"; import Toolbar from "devextreme/ui/toolbar"; Toolbar.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Toolbar properties } }); export default { components: { DxToolbar } } </script>
React
import dxToolbar from "devextreme/ui/toolbar"; import Toolbar from "devextreme-react/toolbar"; dxToolbar.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Toolbar properties } }); export default function App() { return ( <div> <Toolbar id="toolbar1" /> <Toolbar id="toolbar2" /> </div> ) }
dispose()
Disposes of all the resources allocated to the Toolbar instance.
jQuery
After calling this method, remove the DOM element associated with the UI component:
$("#myToolbar").dxToolbar("dispose"); $("#myToolbar").remove();
Angular
Use conditional rendering instead of this method:
<dx-toolbar ... *ngIf="condition"> </dx-toolbar>
Vue
Use conditional rendering instead of this method:
<template> <DxToolbar ... v-if="condition"> </DxToolbar> </template> <script> import DxToolbar from 'devextreme-vue/toolbar'; export default { components: { DxToolbar } } </script>
React
Use conditional rendering instead of this method:
import React from 'react'; import Toolbar from 'devextreme-react/toolbar'; function DxToolbar(props) { if (!props.shouldRender) { return null; } return ( <Toolbar ... > </Toolbar> ); } class App extends React.Component { render() { return ( <DxToolbar shouldRender="condition" /> ); } } export default App;
element()
Gets the root UI component element.
An HTML element or a jQuery element when you use jQuery.
See Also
endUpdate()
Refreshes the UI component after a call of the beginUpdate() method.
Main article: beginUpdate()
See Also
getDataSource()
Gets the DataSource instance.
The DataSource instance.
See Also
getInstance(element)
Gets the instance of a UI component found using its DOM node.
The UI component's instance.
getInstance is a static method that the UI component class supports. The following code demonstrates how to get the Toolbar instance found in an element with the myToolbar
ID:
// Modular approach import Toolbar from "devextreme/ui/toolbar"; ... let element = document.getElementById("myToolbar"); let instance = Toolbar.getInstance(element) as Toolbar; // Non-modular approach let element = document.getElementById("myToolbar"); let instance = DevExpress.ui.dxToolbar.getInstance(element);
See Also
instance()
Gets the UI component's instance. Use it to access other methods of the UI component.
This UI component's instance.
See Also
off(eventName)
Detaches all event handlers from a single event.
The event's name.
The object for which this method is called.
See Also
off(eventName, eventHandler)
Detaches a particular event handler from a single event.
The object for which this method is called.
See Also
on(eventName, eventHandler)
Subscribes to an event.
The object for which this method is called.
Use this method to subscribe to one of the events listed in the Events section.
See Also
on(events)
Subscribes to events.
Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}
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.
See Also
option(optionName)
Gets the value of a single property.
The property's name or full path.
This property's value.
See Also
option(options)
Updates the values of several properties.
Options with their new values.
See Also
repaint()
Repaints the UI component without reloading data. Call it to update the UI component's markup.
See Also
- reload() in DataSource | List
- refresh() in DataGrid | TreeList
resetOption(optionName)
Resets a property to its default value.
A property's name.
See Also
If you have technical questions, please create a support ticket in the DevExpress Support Center.