Type Alias Menu

Menu: {
    caption: string;
    enabled?: boolean;
    hasSeparatorAfter?: boolean;
    hasSeparatorBefore?: boolean;
    menuId: string;
    subMenus?: Menu[];
}

Type declaration

  • caption: string

    The display text of the menu.

  • Optionalenabled?: boolean

    If not provided, the menu is enabled by default. Its enabled state can be updated with the 'update' call.

  • OptionalhasSeparatorAfter?: boolean

    If true, a separator will be placed under this menu in the UI.

  • OptionalhasSeparatorBefore?: boolean

    If true, a separator will be placed above this menu in the UI.

  • menuId: string

    This ID should be unique and not empty. When the menu gets clicked, the message 'menuItemActivated' with this menuId as data is sent back to the extension.

  • OptionalsubMenus?: Menu[]

    The children menus of this menu. They can also be parents of other menus.

Settings