Defines an instance of a command.
The following table lists the properties for this class, along with access and descriptions.
Property |
Access |
Description |
---|---|---|
BaseCmd |
R/O |
GWCommand. Returning an error is equivalent to returning NULL, which is legal. |
LongPrompt |
R/O |
String. Only commands generated and placed on the menu/toolbar with CommandFactory::CustomizeXXX call this method. Returning an error is equivalent to returning NULL, which is legal. |
Parameters |
R/O |
Always NULL. |
PersistentID |
R/O |
String. |
ToolTip |
R/O |
String. Only commands generated and placed on the toolbar with CommandFactory::CustomizeToolbar (or explicitly added by the user) call this method. Returning an error is equivalent to returning NULL, which is legal. |
Execute( )
Help( )
Undo( )
Long Validate( )
eGW_CMDVAL_CHECKED |
The command has a check mark. |
eGW_CMDVAL_DISABLED |
The command is disabled. |
When GWCommand objects are associated with menu items, such as when CommandFactory::ModifyMenu is called, the lifetime of the command will parallel that of the menu.