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;
}

Hierarchy

Properties

args caption className command dataset icon iconClass iconLabel isDisposed isEnabled isToggled isVisible keyBinding label mnemonic submenu type

Methods

dispose

Properties

Readonlyargs

args: ReadonlyJSONObject

The arguments for the command.

Readonlycaption

caption: string

The display caption for the menu item.

ReadonlyclassName

className: string

The extra class name for the menu item.

Readonlycommand

command: string

The command to execute when the item is triggered.

Readonlydataset

dataset: Dataset

The dataset for the menu item.

Readonlyicon

icon: undefined | IRenderer

The icon renderer for the menu item.

ReadonlyiconClass

iconClass: string

The icon class for the menu item.

ReadonlyiconLabel

iconLabel: string

The icon label for the menu item.

ReadonlyisDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

ReadonlyisEnabled

isEnabled: boolean

Whether the menu item is enabled.

ReadonlyisToggled

isToggled: boolean

Whether the menu item is toggled.

ReadonlyisVisible

isVisible: boolean

Whether the menu item is visible.

ReadonlykeyBinding

keyBinding: null | IKeyBinding

The key binding for the menu item.

Readonlylabel

label: string

The display label for the menu item.

Readonlymnemonic

mnemonic: number

The mnemonic index for the menu item.

Readonlysubmenu

submenu: null | Menu

The submenu for a 'submenu' type item.

Readonlytype

type: ItemType

The type of the menu item.

Methods

dispose

  • dispose(): void

  • Dispose of the resources held by the object.

    Notes

    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

Settings

Member Visibility

On This Page

Properties
Methods