GWMenu

Manages a client application’s menus. The C3PO uses this object to modify the menu.

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 property will be NULL for pre-built items.

IsModified

R/O

Boolean.

MenuItems

R/O

GWMenuItems( ).

ObjType

R/O

enumeration (always eGW_GWMENU). 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 which object type has been returned.

Parent

R/O

GWMenu( ).

Methods

Delete( )
  • Deletes GWMenu. This method removes the item from the UI menu and releases the AddRef on GWCommand. Root menus cannot be deleted.

Remarks

None.