Interface IExtensionsMenuApi

API for working with the Extensions menu in Studio Pro.

interface IExtensionsMenuApi {
    _apiId: "mendix.ExtensionsMenuApi";
    add(menuItem: Menu): Promise<void>;
    addEventListener<K>(eventType: K, listener: EventHandler<ExtensionsMenuApiEventMap, K>): DisposeListener;
    removeEventListener<K>(eventType: K, listener: EventHandler<ExtensionsMenuApiEventMap, K>): void;
    update(menuId: string, state: {
        caption?: string;
        enabled?: boolean;
    }): Promise<void>;
}

Hierarchy (view full)

Properties

_apiId

Methods

add addEventListener removeEventListener update

Properties

_apiId

_apiId

Unique identifier that can be used to register or retrieve a specific API.

Example: mendix.EditorsAPI, mycompany.MyFunkyAPI

Methods

add

  • add(menuItem): Promise<void>

  • Adds a menu item to the Extensions menu in the main menu bar of Studio Pro.

    Parameters

    • menuItem: Menu

      The menu item to add.

    Returns Promise<void>

addEventListener

  • addEventListener<K>(eventType, listener): DisposeListener

  • Adds an event listener for the specified event type.

    Type Parameters

    • K extends "menuItemActivated"

    Parameters

    • eventType: K

      The type of event to listen for.

    • listener: EventHandler<ExtensionsMenuApiEventMap, K>

      The event listener to add.

    Returns DisposeListener

    A function that can be called to remove the event listener.

removeEventListener

  • removeEventListener<K>(eventType, listener): void

  • Removes an event listener for the specified event type.

    Type Parameters

    • K extends "menuItemActivated"

    Parameters

    • eventType: K

      The type of event to remove the listener from.

    • listener: EventHandler<ExtensionsMenuApiEventMap, K>

      The event listener to remove.

    Returns void

update

  • update(menuId, state): Promise<void>

  • Updates a menu item in the Extensions menu in the main menu bar of Studio Pro.

    Parameters

    • menuId: string

      The ID of the menu to be updated.

    • state: {
          caption?: string;
          enabled?: boolean;
      }

      The menu item state to update (caption and/or enabled).

      • Optionalcaption?: string
      • Optionalenabled?: boolean

    Returns Promise<void>

Settings

On This Page

Properties
Methods