Context Menu Technical Reference
Summary
- The Context Menu Options section of Adaptable Options a property used to define Context Menus
- AdapTable provides a default menu structure
Context Menu Options
The Context Menu Options section of Adaptable Options is where Context Menus are configured in AdapTable.
The section contains just 1, very flexible, property:
| Property | Description |
|---|---|
| customContextMenu | Customises Context Menu (default context menu items are available in provided context) |
Context Menu API
The Context Menu API provides programmatic access to the Context Menu:
| Method | Description |
|---|---|
| createDefaultMenuStructure(context) | Creates default menu structure; useful as final line in custom implementation |
| createGroupMenu(label, subMenuItems, disabled, icon) | Creates a Group Menu Item |
| getContextMenuItemByLabel(label, context) | Returns Menu Item with given label |
| getContextMenuItemByName(menuItemName, context) | Returns the Menu Item with given name |
| getContextMenuItemsByCategories(categories, context) | Gets all Menu Items in given categories |
| getContextMenuItemsByCategory(category, context) | Gets all Menu Items in a given category |
| getContextMenuItemsByLabels(labels, context) | Returns Menu Items with given labels |
| getContextMenuItemsByNames(menuItemNames, context) | Returns the Menu Items with given names |
| hideContextMenu() | Hide the Context Menu |
| removeAdaptableContextMenuItemByName(menuItemName, context) | Removes Menu Item with given name |
| removeAdaptableContextMenuItemsByNames(menuItemNames, context) | Removes Menu Items with given names |