ICommandUI Interface
Manages user interface commands.
interface class ICommandUI
| Name | Description |
|---|---|
| icommandui__Check | Sets the user interface item for this command to the appropriate check state. |
| ICommandUI::ContinueRouting | Tells the command-routing mechanism to continue routing the current message down the chain of handlers. |
| ICommandUI::Enabled | Enables or disables the user interface item for this command. |
| ICommandUI::ID | Gets the ID of the user interface object represented by the ICommandUI object. |
| ICommandUI::Index | Gets the index of the user interface object represented by the ICommandUI object. |
| ICommandUI::Radio | Sets the user interface item for this command to the appropriate check state. |
| ICommandUI::Text | Sets the text of the user interface item for this command. |
This interface provides methods and properties that manage user interface commands. ICommandUI is similar to CCmdUI Class, except that ICommandUI is used for MFC applications that interoperate with .NET components.
ICommandUI is used within an ON_UPDATE_COMMAND_UI handler in an ICommandTarget-derived class. When a user of an application activates (selects or clicks) a menu, each menu item is displayed as enabled or disabled. The target of each menu command provides this information by implementing an ON_UPDATE_COMMAND_UI handler. For each of the command user interface objects in your application, use the Class Wizard to create a message-map entry and function prototype for each handler.
For more information on how the ICommandUI interface is used in command routing, see How to: Add Command Routing to the Windows Forms Control.
For more information on using Windows Forms, see Using a Windows Form User Control in MFC.
For more information on how user interface commands are managed in MFC, see CCmdUI Class.
Sets the user interface item for this command to the appropriate check state.
property UICheckState Check;
This property sets the user interface item for this command to the appropriate check state. Set Check to the following values:
- 0 Uncheck
- 1 Check
- 2 Set indeterminate
Tells the command routing mechanism to continue routing the current message down the chain of handlers.
void ContinueRouting();
This is an advanced member function that should be used in conjunction with an ON_COMMAND_EX handler that returns FALSE. For more information, see Technical Note TN006: Message Maps.
Enables or disables the user interface item for this command.
property bool Enabled;
This property enables or disables the user interface item for this command. Set Enabled to TRUE to enable the item, FALSE to disable it.
Gets the ID of the user interface object represented by the ICommandUI object.
property unsigned int ID;
This property gets the ID (a handle) of the menu item, toolbar button, or other user interface object represented by the ICommandUI object.
Gets the index of the user interface object represented by the ICommandUI object.
property unsigned int Index;
This property gets the index (a handle) of the menu item, toolbar button, or other user interface object represented by the ICommandUI object.
Sets the user interface item for this command to the appropriate check state.
property bool Radio;
This property sets the user interface item for this command to the appropriate check state. Set Radio to TRUE to enable the item; otherwise FALSE.
Sets the text of the user interface item for this command.
property String^ Text;
This property sets the text of the user interface item for this command. Set Text to a text string handle.
Header: afxwinforms.h (defined in assembly atlmfc\lib\mfcmifc80.dll)