Interface IEditMenu

An interface for an Edit menu.

interface IEditMenu {
    clearers: IClearer;
    goToLiners: SemanticCommand;
    isDisposed: boolean;
    items: readonly IItem[];
    rank?: number;
    undoers: IUndoer;
    addGroup(items, rank?): IDisposable;
    addItem(options): IDisposable;
    dispose(): void;
}

Hierarchy (view full)

Implemented by

Properties

clearers goToLiners isDisposed items rank? undoers

Methods

addGroup addItem dispose

Properties

Readonly clearers

clearers: IClearer

Semantic commands IClearers for the Edit menu.

Readonly goToLiners

goToLiners: SemanticCommand

Semantic commands IGoToLiners for the Edit menu.

Readonly isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

Readonly items

items: readonly IItem[]

A read-only array of the menu items in the menu.

Optional Readonly rank

rank?: number

Menu rank

Readonly undoers

undoers: IUndoer

Semantic commands IUndoers for the Edit menu.

Methods

addGroup

  • addGroup(items, rank?): IDisposable

  • Add a group of menu items specific to a particular plugin.

    The rank can be set for all items in the group using the function argument or per item.

    Parameters

    • items: IItemOptions[]

      the list of menu items to add.

    • Optional rank: number

      the default rank in the menu in which to insert the group.

    Returns IDisposable

    Disposable of the group

addItem

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

Theme

On This Page

clearersgoToLinersisDisposeditemsrankundoersaddGroupaddItemdispose