VCOM:VectorWorks:Workspaces:IWorkspaceMenuChunk::AddMenuItem

.SDK|SDK ..SDK:Types|SDK Types ..VCOM:VCOM (Vectorworks Component Object Model)|VCOM Basics ..VCOM:Class Reference|VCOM Class Reference

Description

namespace VectorWorks::Workspaces

Member of VCOM:VectorWorks:Workspaces:IWorkspaceMenuChunk

Adds to the collection of menu items in this chunk.

virtual VCOMError VCOM_CALLTYPE AddMenuItem(
                       const TXString&   inMenuItemDisplayText,
                       bool              inHasShortcutKey = false,
                       char              inShortcutKey = 0,
                       Uint32            inShortcutKeyModifiers = 0) = 0;

Parameters

inMenuItemDisp		const TXString&		the localized text used for this menu item.
inHasShortcutKey		bool		if there is a short cut key and modifier for this item, this will be true. Defaults to false.
inShortcutKey		char		the short cut key that will activate this menu item.
inShortcutKeyModifiers		Uint32		the accompanying necessary modifier keys required to activate this menu item.

Return Value

Uses standard VCOM Error Reporting.

Return value meaning:

kVCOMError_NotInitialized		Bad VCOM instance used to call the fuction.
kVCOMError_Failed		Routine failed.