VCDeletePopupMenu

Version:

1.2

Description:

Toggles the display of the default commands on the current tools pop-up menu.

Declaration:

C/C++

extern "C" void WINAPI VCDeletePopupMenu(vbool tf);

Delphi

procedure VCDeletePopupMenu(tf: Wordbool); stdcall;

ActiveX/COM

Sub DeletePopupMenu(ByVal tf As Integer)

Parameters:

tf - set according to whether the default pop-up commands should be displayed.
0 - do not display.
1 - display the default commands.

Notes:

While pop-up menus can be defined independently by the user, VCAddPopupCommand allows a native command to be added to the pop-up menu of the currently active tool for only the current session of that tool. When the tool is no longer active, any commands added to the tool will be lost and need to be re-added if required for the next instance of that tool. If the pop-up needs to be cleared of all default commands, VCDeletePopupMenu will remove all the existing defaults for the current instance of the tool.

VCDeletePopupMenu will not affect commands added with VCAddPopupCommand. Remember that these commands only work on the current tool i.e. there must be a tool active in order to add to or delete the contents of the pop-up menu.