Interface IDisposableMenuItem

Interface for disposable item menu

interface IDisposableMenuItem {
    args: ReadonlyJSONObject;
    caption: string;
    className: string;
    command: string;
    dataset: Dataset;
    icon: undefined | IRenderer;
    iconClass: string;
    iconLabel: string;
    isDisposed: boolean;
    isEnabled: boolean;
    isToggled: boolean;
    isVisible: boolean;
    keyBinding: null | IKeyBinding;
    label: string;
    mnemonic: number;
    submenu: null | Menu;
    type: ItemType;
    dispose(): void;



The arguments for the command.

caption: string

The display caption for the menu item.

className: string

The extra class name for the menu item.

command: string

The command to execute when the item is triggered.

dataset: Dataset

The dataset for the menu item.

icon: undefined | IRenderer

The icon renderer for the menu item.

iconClass: string

The icon class for the menu item.

iconLabel: string

The icon label for the menu item.

isDisposed: boolean

Test whether the object has been disposed.


This property is always safe to access.

isEnabled: boolean

Whether the menu item is enabled.

isToggled: boolean

Whether the menu item is toggled.

isVisible: boolean

Whether the menu item is visible.

keyBinding: null | IKeyBinding

The key binding for the menu item.

label: string

The display label for the menu item.

mnemonic: number

The mnemonic index for the menu item.

submenu: null | Menu

The submenu for a 'submenu' type item.

type: ItemType

The type of the menu item.


  • Dispose of the resources held by the object.


    If the object's dispose method is called more than once, all calls made after the first will be a no-op.

    Undefined Behavior

    It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

    Returns void