GWMenuItem

Associates a GWCommand( ) object with a menu item.

Properties

The following table lists the properties for this class, along with access and descriptions.

Property

Access

Description

Caption

R/W

String.

GWCommand

R/W

GWCommand. For pre-built items, the CommandFactory in the ClientState object is used to build the value of this property. Otherwise, this command will be NULL for pre-built items. A client can also implement the GWCommand factory, but still return NULL for certain menu items. Hence, C3POServers should never assume they will receive non-NULL GWCommand objects for every menu item.

ObjType

R/O

enumeration ( eGW_GWMENU, eGW_GWMENUACTION, eGW_GWMENUSEPARATOR) Indicates the proper subtype of GWMenuItem being referenced. For example, the GWMenuItems::Item method returns either a GWMenuAction or a GWMenu object, both of which are subtypes of GWMenuItem. The ObjType can be used to distinguish the object type that has been returned.

Parent

R/O

GWMenuItems.

Methods

Delete( )
  • Deletes GWMenuItem, which removes the item from the UI menu and releases the AddRef on the GWCommand object.

Remarks

None.