Admin Production ni-theme
Current Publication

ShowBuiltInCtrlMenuItem

LabWindows/CVI

ShowBuiltInCtrlMenuItem

int ShowBuiltInCtrlMenuItem (int panelHandle, int controlID, int builtInMenuItemID, int beforeMenuItemID);

Purpose

Makes a control built-in popup menu show a built-in menu item.

Call this function only if you previously hid the menu item by calling HideBuiltInCtrlMenuItem.

Supported Controls

You can use ShowBuiltInCtrlMenuItem with the following controls:

Parameters

Input
Name Type Description
panelHandle int Specifier for a particular panel that is currently in memory. You can obtain this handle from functions such as LoadPanel and NewPanel.
controlID int The defined constant, located in the .uir header file, that you assigned to the control in the User Interface Editor, or the ID returned by functions such as NewCtrl and DuplicateCtrl.
builtInMenuItemID int The built-in menu item to display. builtInMenuItemID must be one of the following constants:

Constant Name Constant Value Control Type
VAL_GOTO –2 Table
VAL_FIND –3 Table, tree
VAL_SORT –4 Table, tree
VAL_EXPAND_SUBTREE –5 Tree
VAL_COLLAPSE_SUBTREE –6 Tree
VAL_EXPAND_ALL –7 Tree
VAL_COLLAPSE_ALL –8 Tree
VAL_PLOT_COLOR –9 Graph, strip chart
VAL_PLOT_STYLE –10 Graph, strip chart
VAL_PLOT_POINT_STYLE –11 Graph, strip chart
VAL_PLOT_LINE_STYLE –12 Graph, strip chart
VAL_PLOT_BGCOLOR –13 Graph
VAL_PLOT_ORIGIN –14 Graph
VAL_PLOT_FONT –15 Graph
VAL_PLOT_FILL_COLOR –16 Graph
VAL_PLOT_VISIBLE –17 Graph, strip chart
VAL_PLOT_RENAME –18 Graph, strip chart
VAL_PLOT_LINE_THICKNESS –19 Graph, strip chart
VAL_FIND_NEXT –20 Table, tree
VAL_FIND_PREV –21 Table, tree
beforeMenuItemID int The menu item ID above which to insert the new built-in menu item.

Use a menuItemID you obtained from NewCtrlMenuItem or NewCtrlMenuSeparator, or use a constant that identifies one of the built-in control menu items. The following lists the built-in menu item constants:

Constant Name Constant Value Control Type
VAL_GOTO –2 Table
VAL_FIND –3 Table, tree
VAL_SORT –4 Table, tree
VAL_EXPAND_SUBTREE –5 Tree
VAL_COLLAPSE_SUBTREE –6 Tree
VAL_EXPAND_ALL –7 Tree
VAL_COLLAPSE_ALL –8 Tree
VAL_PLOT_COLOR –9 Graph, strip chart
VAL_PLOT_STYLE –10 Graph, strip chart
VAL_PLOT_POINT_STYLE –11 Graph, strip chart
VAL_PLOT_LINE_STYLE –12 Graph, strip chart
VAL_PLOT_BGCOLOR –13 Graph
VAL_PLOT_ORIGIN –14 Graph
VAL_PLOT_FONT –15 Graph
VAL_PLOT_FILL_COLOR –16 Graph
VAL_PLOT_VISIBLE –17 Graph, strip chart
VAL_PLOT_RENAME –18 Graph, strip chart
VAL_PLOT_LINE_THICKNESS –19 Graph, strip chart
VAL_FIND_NEXT –20 Table, tree
VAL_FIND_PREV –21 Table, tree


To place the new menu item at the bottom of the menu item list, pass –1.

Return Value

Name Type Description
menuItemID int Returns the ID that you use to specify this menu item in subsequent function calls. Negative values indicate that an error occurred. Zero is not a valid ID.

Additional Information

Library: User Interface Library

Include file: userint.h

LabWindows/CVI compatibility: LabWindows/CVI 5.5 and later

Example

Refer to userint\treemenu.cws for an example of using the ShowBuiltInCtrlMenuItem function.