GWMenuAction

Represents a simple menu item, which is not a submenu.

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.

MenuID

R/O

Long. The menu ID associated with the menu. When a C3PO adds items to a GWMenu, the MenuIDs are allocated automatically. The C3PO can read this property to obtain the allocated ID.

ObjType

R/O

enumeration (always eGW_GWMENUACTION). 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. For the GWMenuAction( ) object, this property is always set to eMenuAction.

Parent

R/O

GWMenu( ).

Methods

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

Remarks

None.