JavaScript/jQuery ContextMenu Methods
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)
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 ContextMenu UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxContextMenu.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the ContextMenu properties
}
});Angular
import ContextMenu from "devextreme/ui/context_menu";
// ...
export class AppComponent {
constructor () {
ContextMenu.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the ContextMenu properties
}
});
}
}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 properties
}
});
export default {
components: {
DxContextMenu
}
}
</script>React
import React, {useEffect} from "react";
import dxContextMenu from "devextreme/ui/context_menu";
import ContextMenu from "devextreme-react/context-menu";
export default function App() {
useEffect(() => {
dxContextMenu.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the ContextMenu properties
}
})
});
return (
<div>
<ContextMenu id="contextMenu1" />
<ContextMenu id="contextMenu2" />
</div>
)
}dispose()
After calling this method, remove the DOM element associated with the UI component:
$("#myContextMenu").dxContextMenu("dispose");
$("#myContextMenu").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-context-menu ...
*ngIf="condition">
</dx-context-menu>Vue
<template>
<DxContextMenu ...
v-if="condition">
</DxContextMenu>
</template>
<script>
import DxContextMenu from 'devextreme-vue/context-menu';
export default {
components: {
DxContextMenu
}
}
</script>React
import React from 'react';
import ContextMenu from 'devextreme-react/context-menu';
function DxContextMenu(props) {
if (!props.shouldRender) {
return null;
}
return (
<ContextMenu ... >
</ContextMenu>
);
}
class App extends React.Component {
render() {
return (
<DxContextMenu shouldRender="condition" />
);
}
}
export default App;See Also
getDataSource()
Gets the DataSource instance.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout
- 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 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 UI component is hidden. It is a native Promise or a jQuery.Promise when you use jQuery.
registerKeyHandler(key, handler)
A handler. Accepts the keydown event as the argument. It is a EventObject 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
show()
A Promise that is resolved after the UI component is shown. It is a native Promise or a jQuery.Promise when you use jQuery.
toggle(showing)
A Promise that is resolved after the UI component is shown/hidden. It is a native Promise or a jQuery.Promise when you use jQuery.