GlideMenu (g_menu and g_item) - Client

  • Release version: Yokohama
  • Updated January 30, 2025
  • 2 minutes to read

    • The GlideMenu API provides methods that can be used in UI context menus and in onShow scripts to customize UI context menu items.

    There is no constructor for the GlideMenu class. Access GlideMenu methods using the g_menu global object.
    • g_menu is the UI context menu that is about to be shown. The onShow script can make changes to the appearance of the menu before it is displayed using these methods.
    • g_item is the current UI context menu item that is about to be shown. It is used in several of the g_menu methods to specify an item.

    GlideMenu - clearImage(GlideMenuItem item)

    Clears the image for an item.

    Table 1. Parameters
    Name Type Description
    item GlideMenuItem Specifies the item to have its image removed from display.
    Table 2. Returns
    Type Description
    void 
    g_menu.clearImage(g_item);

    GlideMenu - clearSelected()

    Clears any selection images from items in the menu.

    Table 3. Parameters
    Name Type Description
    None
    Table 4. Returns
    Type Description
    void

    GlideMenu - getItem(String itemID)

    Returns a menu item by item ID.

    It can be necessary to find an item in a menu so that it can be changed before being displayed. Each menu item may be assigned a unique ID when the menu item is created (either from a UI Context Menu entry or from the addAction() method in the Dynamic Script Action).

    Table 5. Parameters
    Name Type Description
    itemID String Specifies the item to be returned.
    Table 6. Returns
    Type Description
    GlideMenuItem The menu item

    GlideMenu - setDisabled(GlideMenuItem item)

    Disables a menu item so that it cannot be selected. The disabled menu item is displayed in a lighter color (grayed out) to indicate it is disabled.

    Table 7. Parameters
    Name Type Description
    item GlideMenuItem The item to be disabled.
    Table 8. Returns
    Type Description
    void 
    g_menu.setDisabled(g_item);

    GlideMenu - setEnabled(GlideMenuItem item)

    Enables the specified menu item.

    Table 9. Parameters
    Name Type Description
    item GlideMenuItem The item to be enabled.
    Table 10. Returns
    Type Description
    void 
    g_menu.setEnabled(g_item);

    GlideMenu - setHidden(GlideMenuItem item)

    Hides the specified menu item.

    When hiding menu items, the separator bars are not adjusted, so it is possible to end up with the menu showing two separators in a row.

    Table 11. Parameters
    Name Type Description
    item GlideMenuItem The item to be hidden.
    Table 12. Returns
    Type Description
    void 
    g_menu.setHidden(g_item);

    GlideMenu - setImage(GlideMenuItem item, String imgSrc)

    Sets an image for an item.

    Table 13. Parameters
    Name Type Description
    item GlideMenuItem the item to have the image displayed.
    imgSrc String the image to attach to the menu item.
    Table 14. Returns
    Type Description
    void 
    g_menu.setImage(g_item, 'images/checked.gifx');

    GlideMenu - setLabel(GlideMenuItem item, String label)

    Sets the display label for a menu item. The label may contain HTML.

    Table 15. Parameters
    Name Type Description
    item GlideMenuItem the item to be labeled.
    label String the label to be displayed. The string may contain HTML.
    Table 16. Returns
    Type Description
    void 
    g_menu.setLabel(g_item, "This is a new label");

    GlideMenu - setVisible(GlideMenuItem item)

    Displays the specified item.

    Table 17. Parameters
    Name Type Description
    item GlideMenuItem The item to be displayed.
    Table 18. Returns
    Type Description
    void 
    g_menu.setVisible(g_item);