JavaScript/jQuery ContextMenu Methods
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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 ContextMenu widget in an application executed on the desktop.
jQuery
DevExpress.ui.dxContextMenu.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the ContextMenu options } });
Angular
import ContextMenu from "devextreme/ui/context_menu"; // ... export class AppComponent { constructor () { ContextMenu.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the ContextMenu options } }); } }
Vue
<template> <div> <DxContextMenu id="contextMenu1" /> <DxContextMenu id="contextMenu2" /> </div> </template> <script> import DxContextMenu from "devextreme-vue/context-menu"; import ContextMenu from "devextreme/ui/context_menu"; ContextMenu.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the ContextMenu options } }); export default { components: { DxContextMenu } } </script>
React
import React from "react"; import dxContextMenu from "devextreme/ui/context_menu"; import ContextMenu from "devextreme-react/context-menu"; class App extends React.Component { render () { dxContextMenu.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the ContextMenu options } }) return ( <div> <ContextMenu id="contextMenu1" /> <ContextMenu id="contextMenu2" /> </div> ) } } export default App;
dispose()
After calling this method, remove the DOM element associated with the widget:
jQuery
$("#myContextMenu").dxContextMenu("dispose"); $("#myContextMenu").remove();
Angular
<dx-context-menu #contextMenuVar id="myContextMenu"></dx-context-menu>
import { ..., ViewChild } from "@angular/core"; import { DxContextMenuComponent } from "devextreme-angular"; // ... export class AppComponent { @ViewChild("contextMenuVar", { static: false }) contextMenu: DxContextMenuComponent; // Prior to Angular 8 // @ViewChild("contextMenuVar") contextMenu: DxContextMenuComponent; removeContextMenu (e) { this.contextMenu.instance.dispose(); document.getElementById("myContextMenu").remove(); } }
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 widget 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
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 widget class supports. The following code demonstrates how to get the ContextMenu instance found in an element with the myContextMenu
ID:
// Modular approach import ContextMenu from "devextreme/ui/context_menu"; ... let element = document.getElementById("myContextMenu"); let instance = ContextMenu.getInstance(element) as ContextMenu; // Non-modular approach let element = document.getElementById("myContextMenu"); let instance = DevExpress.ui.dxContextMenu.getInstance(element);
See Also
hide()
A Promise that is resolved after the widget is hidden. It is a native Promise or a jQuery.Promise when you use jQuery.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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 widget options.
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
selectItem(itemElement)
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
show()
A Promise that is resolved after the widget is shown. It is a native Promise or a jQuery.Promise when you use jQuery.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
toggle(showing)
A Promise that is resolved after the widget is shown/hidden. It is a native Promise or a jQuery.Promise when you use jQuery.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- show()
- hide()
unselectItem(itemElement)
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.