Click here for NewsObjects Overview
InsertContextMenuSeparator Method
Windows - Visual C++


Description
The InsertContextMenuSeparator method inserts a separator item into the control's context menu at a specified position.

Syntax
long result = InsertContextMenuSeparator(short menuID, short insertPosition);

The InsertContextMenuSeparator syntax has these parts:

 Part

Description

menuID

A short integer containing the menu ID of the menu to address as described in Remarks.

insertPosition

A short integer containing the position in which to insert the separator. insertPosition is one-based.

result

A long integer containing 0 if successful and an error code if not.

Remarks
The context menu is the menu that appears when you right click on the control. It can be turned on or off by setting the ContextMenuEnabled property. The context menu is initially empty; you add your preferred menu items to it using the ContextMenuItem methods.

The menuID parameter is used to indicate whether to address the main context menu or a submenu. The menuID of the main context menu is always 0. The menuID of a submenu is returned when the submenu is created with AppendContextMenuSubmenu or InsertContextMenuSubmenu. Note that this menuID has no relation to any ID used by the Windows API.

See Also: AppendContextMenuItem AppendContextMenuSeparator AppendContextMenuSubmenu GetContextMenuItemCount InsertContextMenuItem InsertContextMenuSubmenu RemoveContextMenuItem ContextMenu ContextMenuEnabled UpdateContextMenu

Back to: Headline Methods Quote Methods Story Methods