JavaScript/jQuery ContextMenu Methods
beginUpdate()
Postpones rendering that can negatively affect performance until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
defaultOptions(rule)
| Name | Type | Description |
|---|---|---|
| device | | |
Device parameters. |
| options |
Options to be applied. |
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, { Properties } from "devextreme/ui/context_menu";
// ...
export class AppComponent {
constructor () {
ContextMenu.defaultOptions<Properties>({
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 dxContextMenu from "devextreme/ui/context_menu";
import ContextMenu from "devextreme-react/context-menu";
dxContextMenu.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the ContextMenu properties
}
});
export default function App() {
return (
<div>
<ContextMenu id="contextMenu1" />
<ContextMenu id="contextMenu2" />
</div>
)
}You can also set rules for multiple device types:
jQuery
const devicesConfig = [
{ deviceType: 'desktop' },
{ deviceType: 'tablet' },
{ deviceType: 'phone' },
];
devicesConfig.forEach(deviceConfig => {
DevExpress.ui.dxContextMenu.defaultOptions({
device: deviceConfig,
options: {
// Here go the ContextMenu properties
}
});
});Angular
import ContextMenu, { Properties } from "devextreme/ui/context_menu";
// ...
export class AppComponent {
constructor () {
const devicesConfig = [
{ deviceType: 'desktop' },
{ deviceType: 'tablet' },
{ deviceType: 'phone' },
];
devicesConfig.forEach(deviceConfig => {
ContextMenu.defaultOptions<Properties>({
device: deviceConfig,
options: {
// Here go the ContextMenu properties
}
});
});
}
}Vue
<template>
<div>
<DxContextMenu />
</div>
</template>
<script>
import DxContextMenu from "devextreme-vue/context-menu";
import ContextMenu from "devextreme/ui/context_menu";
const devicesConfig = [
{ deviceType: 'desktop' },
{ deviceType: 'tablet' },
{ deviceType: 'phone' },
];
devicesConfig.forEach(deviceConfig => {
ContextMenu.defaultOptions({
device: deviceConfig,
options: {
// Here go the ContextMenu properties
}
});
});
export default {
components: {
DxContextMenu
}
}
</script>React
import dxContextMenu from "devextreme/ui/context_menu";
import ContextMenu from "devextreme-react/context-menu";
const devicesConfig = [
{ deviceType: 'desktop' },
{ deviceType: 'tablet' },
{ deviceType: 'phone' },
];
devicesConfig.forEach(deviceConfig => {
dxContextMenu.defaultOptions({
device: deviceConfig,
options: {
// Here go the ContextMenu properties
}
});
});
export default function App() {
return (
<div>
<ContextMenu />
</div>
)
}dispose()
jQuery
After calling this method, remove the DOM element associated with the UI component:
$("#myContextMenu").dxContextMenu("dispose");
$("#myContextMenu").remove();Angular
Use conditional rendering instead of this method:
<dx-context-menu ...
*ngIf="condition">
</dx-context-menu>Vue
Use conditional rendering instead of this method:
<template>
<DxContextMenu ...
v-if="condition">
</DxContextMenu>
</template>
<script>
import DxContextMenu from 'devextreme-vue/context-menu';
export default {
components: {
DxContextMenu
}
}
</script>React
Use conditional rendering instead of this method:
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;endUpdate()
Refreshes the UI component after a call of the beginUpdate() method.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
getDataSource()
Gets the DataSource instance.
See Also
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.
on(eventName, eventHandler)
Use this method to subscribe to one of the events listed in the Events section.
See Also
on(events)
Use this method to subscribe to several events with one method call. Available events are listed in the Events section.
See Also
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
repaint()
Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically.
The repaint() method re-initializes the component with new settings, resetting its state and history.
See Also
- reload() in DataSource | List
- refresh() in DataGrid | TreeList
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.