Interface PHXDATAHISTORYLib::IPHXMenuItems
Last update: 16.07.2025
Definition: LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl (line 1164)
An object which is used to get extra context dependent menu items from PHXDataExplorerPlugIn pages through the getMenuItems call.
Members
Properties
Property numItems
Definition: LIBS/DataExplorer/PHXDataHistory/PHXDataHistory.odl (line 1)
long PHXDATAHISTORYLib::IPHXMenuItems::numItems
The number of context dependent menu items. Set this first, then use setMenuItem() for each menu item.
Return type: long
Public functions
Function setMenuItem
void PHXDATAHISTORYLib::IPHXMenuItems::setMenuItem(long index, BSTR name, BSTR description)
Sets the data for a particular menu item.
Parameters:
- index: A 0 based index of the menu item to set.
- name: The name of the menu item. This will display in the menu itself.
- description: The description of the menu item. Will be displayed in tooltips and the status bar when the user hovers over a menu item.
Parameters:
- long index
- BSTR name
- BSTR description
Return type: void
Function getMenuItemName
BSTR PHXDATAHISTORYLib::IPHXMenuItems::getMenuItemName(long index)
Gets the name of the menu item.
Parameters:
- index: A 0 based index of the menu item to access.
Returns:
The menu item name.
Parameters:
- long index
Return type: BSTR
Function getMenuItemDescription
BSTR PHXDATAHISTORYLib::IPHXMenuItems::getMenuItemDescription(long index)
Gets the description field for the requested menu item.
Parameters:
- index: A 0 based index of the menu item to access.
Returns:
The value of the description field of the menu item.
Parameters:
- long index
Return type: BSTR
