beginUpdate()
Prevents the widget from refreshing until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods prevent the widget from excessive updates when you are changing multiple widget settings at once. After the beginUpdate() method is called, the widget does not update its UI until the endUpdate() method is called.
See Also
defaultOptions(rule)
defaultOptions is a static method that the widget class supports. The following code demonstrates how to specify default options for all instances of the NavBar widget in an application executed on the desktop.
jQuery
DevExpress.ui.dxNavBar.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the NavBar options } });
Angular
import NavBar from "devextreme/ui/nav_bar"; // ... export class AppComponent { constructor () { NavBar.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the NavBar options } }); } }
Vue
<template> <div> <dx-nav-bar id="navBar1" /> <dx-nav-bar id="navBar2" /> </div> </template> <script> import DxNavBar from "devextreme-vue/nav-bar"; import NavBar from "devextreme/ui/nav_bar"; NavBar.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the NavBar options } }); export default { components: { DxNavBar } } </script>
React
import React from "react"; import dxNavBar from "devextreme/ui/nav_bar"; import NavBar from "devextreme-react/nav-bar"; class App extends React.Component { render () { dxNavBar.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the NavBar options } }) return ( <div> <NavBar id="navBar1" /> <NavBar id="navBar2" /> </div> ) } } export default App;
dispose()
The following code disposes of an NavBar instance that corresponds to the element ID (or reference variable in Angular) and removes the element from the DOM:
jQuery
$("#myNavBar").dxNavBar("dispose"); $("#myNavBar").remove();
Angular
<dx-nav-bar #navBarVar id="myNavBar"></dx-nav-bar>
import { ..., ViewChild } from "@angular/core"; import { DxNavBarComponent } from "devextreme-angular"; // ... export class AppComponent { @ViewChild("navBarVar") navBar: DxNavBarComponent; removeNavBar (e) { this.navBar.instance.dispose(); document.getElementById("myNavBar").remove(); } }
endUpdate()
Refreshes the widget after a call of the beginUpdate() method.
Main article: beginUpdate()
See Also
getDataSource()
Gets the DataSource instance.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
- Data Layer - Overview
- Data Layer - DataSource Examples
getInstance(element)
getInstance is a static method that the widget class supports. The following code demonstrates how to get the NavBar instance found in an element with the myNavBar
ID:
// Modular approach import NavBar from "devextreme/ui/nav_bar"; ... let element = document.getElementById("myNavBar"); let instance = NavBar.getInstance(element) as NavBar; // Non-modular approach let element = document.getElementById("myNavBar"); let instance = DevExpress.ui.dxNavBar.getInstance(element);
See Also
option()
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
option(optionName)
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
option(optionName, optionValue)
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
option(options)
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
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.