Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IDisposableMenuItem

Interface for disposable item menu

Hierarchy

  • IDisposable
  • IItem
    • IDisposableMenuItem

Index

Properties

Methods

Properties

Readonly args

args: ReadonlyJSONObject

The arguments for the command.

Readonly caption

caption: string

The display caption for the menu item.

Readonly className

className: string

The extra class name for the menu item.

Readonly command

command: string

The command to execute when the item is triggered.

Readonly dataset

dataset: Dataset

The dataset for the menu item.

Readonly icon

icon: string | IRenderer

The icon renderer for the menu item.

Readonly iconClass

iconClass: string

The icon class for the menu item.

Readonly iconLabel

iconLabel: string

The icon label for the menu item.

Readonly isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

Readonly isEnabled

isEnabled: boolean

Whether the menu item is enabled.

Readonly isToggled

isToggled: boolean

Whether the menu item is toggled.

Readonly isVisible

isVisible: boolean

Whether the menu item is visible.

Readonly keyBinding

keyBinding: IKeyBinding

The key binding for the menu item.

Readonly label

label: string

The display label for the menu item.

Readonly mnemonic

mnemonic: number

The mnemonic index for the menu item.

Readonly submenu

submenu: Menu

The submenu for a 'submenu' type item.

Readonly type

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

Generated using TypeDoc