Client API reference › API reference › API implementation and reference
GlideMenu (g_menu and g_item)- Client
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.
Parent Topic:Client API reference
Clears the image for an item.
| Name | Type | Description |
|---|
| item | GlideMenuItem | Specifies the item to have its image removed from display. |
g_menu.clearImage(g_item);
Clears any selection images from items in the menu.
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).
| Name | Type | Description |
|---|
| itemID | String | Specifies the item to be returned. |
| Type | Description |
|---|
| GlideMenuItem | The menu 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.
| Name | Type | Description |
|---|
| item | GlideMenuItem | The item to be disabled. |
g_menu.setDisabled(g_item);
Enables the specified menu item.
| Name | Type | Description |
|---|
| item | GlideMenuItem | The item to be enabled. |
g_menu.setEnabled(g_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.
| Name | Type | Description |
|---|
| item | GlideMenuItem | The item to be hidden. |
g_menu.setHidden(g_item);
Sets an image for an item.
| Name | Type | Description |
|---|
| item | GlideMenuItem | the item to have the image displayed. |
| imgSrc | String | the image to attach to the menu item. |
g_menu.setImage(g_item, 'images/checked.gifx');
Sets the display label for a menu item. The label may contain HTML.
| Name | Type | Description |
|---|
| item | GlideMenuItem | the item to be labeled. |
| label | String | the label to be displayed. The string may contain HTML. |
g_menu.setLabel(g_item, "This is a new label");
Displays the specified item.
| Name | Type | Description |
|---|
| item | GlideMenuItem | The item to be displayed. |
g_menu.setVisible(g_item);