COleCmdUI クラスCOleCmdUI Class

アプリケーションの IOleCommandTargetドリブンの機能に関連するユーザー インターフェイス オブジェクトの状態を更新するメソッドを MFC に提供します。Implements a method for MFC to update the state of user-interface objects related to the IOleCommandTarget-driven features of your application.


class COleCmdUI : public CCmdUI


パブリック コンストラクターPublic Constructors

名前Name 説明Description
COleCmdUI::COleCmdUICOleCmdUI::COleCmdUI COleCmdUI オブジェクトを構築します。Constructs a COleCmdUI object.

パブリック メソッドPublic Methods

名前Name 説明Description
COleCmdUI:: EnableCOleCmdUI::Enable Enable コマンドフラグを設定または解除します。Sets or clears the enable command flag.
COleCmdUI::SetCheckCOleCmdUI::SetCheck オン/オフのトグルコマンドの状態を設定します。Sets the state of an on/off toggle command.
COleCmdUI:: SetTextCOleCmdUI::SetText コマンドのテキスト名またはステータス文字列を返します。Returns a text name or status string for a command.


DocObjects が有効になっていないアプリケーションでは、ユーザーがアプリケーションのメニューを表示すると、MFC は、通知を UPDATE_COMMAND_UI します。In an application that is not enabled for DocObjects, when the user views a menu in the application, MFC processes UPDATE_COMMAND_UI notifcations. 各通知には、特定のコマンドの状態を反映するために操作できる CCmdUI オブジェクトが付与されます。Each notification is given a CCmdUI object that can be manipulated to reflect the state of a particular command. ただし、アプリケーションが DocObjects に対して有効になっている場合、MFC は通知 UPDATE_OLE_COMMAND_UI 処理し、オブジェクトを割り当て COleCmdUI ます。However, when your application is enabled for DocObjects, MFC processes UPDATE_OLE_COMMAND_UI notifications and assigns COleCmdUI objects.

COleCmdUI DocObject が、コンテナーのユーザーインターフェイス (FileNew、Open、Print など) で発生したコマンドを受け取ることができるようにします。また、DocObject のユーザーインターフェイスで生成されたコマンドをコンテナーが受信できるようにします。COleCmdUI allows a DocObject to receive commands that originate in its container's user interface (such as FileNew, Open, Print, and so on), and allows a container to receive commands that originate in the DocObject's user interface. IDispatch 、同じコマンドをディスパッチするために使用できますが、は、 IOleCommandTarget 標準のコマンドセット (通常は引数を含まない) に依存していて、型情報が関係していないため、より簡単なクエリおよび実行方法を提供します。Although IDispatch could be used to dispatch the same commands, IOleCommandTarget provides a simpler way to query and execute because it relies on a standard set of commands, usually without arguments, and no type information is involved. COleCmdUI DocObject user interface コマンドの他のプロパティを有効にしたり、更新したり、設定したりするために使用できます。COleCmdUI can be used to enable, update, and set other properties of DocObject user interface commands. コマンドを起動する場合は、 COleServerDoc:: OnExecOleCmdを呼び出します。When you want to invoke the command, call COleServerDoc::OnExecOleCmd.

DocObjects の詳細については、「 CDocObjectServer and CDocObjectServerItem」を参照してください。For further information on DocObjects, see CDocObjectServer and CDocObjectServerItem.

継承階層Inheritance Hierarchy




ヘッダー: afxdocobHeader: afxdocob.h


特定の COleCmdUI ユーザーインターフェイスコマンドに関連付けられたオブジェクトを構築します。Constructs a COleCmdUI object associated with a particular user-interface command.

    OLECMD* rgCmds,
    ULONG cCmds,
    const GUID* m_pGroup);


指定した GUID に関連付けられている、サポートされているコマンドの一覧。A list of supported commands associated with the given GUID. OLECMD構造体はコマンドをコマンドフラグに関連付けます。The OLECMD structure associates commands with command flags.

RgCmds 内のコマンドの数。The count of commands in rgCmds.

コマンドのセットを識別する GUID へのポインター。A pointer to a GUID that identifies a set of commands.


オブジェクトには、 COleCmdUI メニュー項目やコントロールバーボタンなどの DocObject ユーザーインターフェイスオブジェクトを更新するためのプログラムインターフェイスが用意されています。The COleCmdUI object provides a programmatic interface for updating DocObject user-interface objects such as menu items or control-bar buttons. オブジェクトを使用して、ユーザーインターフェイスオブジェクトを有効にしたり、無効にしたり、チェックしたり、クリアしたりでき COleCmdUI ます。The user-interface objects can be enabled, disabled, checked, and/or cleared through the COleCmdUI object.

COleCmdUI:: EnableCOleCmdUI::Enable

この関数を呼び出して、オブジェクトのコマンドフラグを OLECOMDF_ENABLED に設定します。これにより COleCmdUI 、コマンドが使用可能で有効になっていることをインターフェイスに通知したり、コマンドフラグをクリアしたりできます。Call this function to set the command flag of the COleCmdUI object to OLECOMDF_ENABLED, which tells the interface the command is available and enabled, or to clear the command flag.

virtual void Enable(BOOL bOn);


オブジェクトに関連付けられたコマンドを有効にするか無効にするかを示し COleCmdUI ます。Indicates whether the command associated with the COleCmdUI object should be enabled or disabled. 0以外の場合、コマンドを有効にします。0の場合、コマンドは無効になります。Nonzero enables the command; 0 disables the command.


この関数を呼び出して、on/off トグルコマンドの状態を設定します。Call this function to set the state of an on/off toggle command.

virtual void SetCheck(int nCheck);


オン/オフの切り替えコマンドを設定する状態を決定する値。A value determining the state to set an on/off toggle command. 値は次のとおりです。Values are:

Value 説明Description
11 コマンドを on に設定します。Sets the command to on.
22 コマンドを不確定に設定します。このコマンドの属性が関連する選択項目のオン状態とオフ状態の両方にあるため、状態を特定できません。Sets the command to indeterminate; the state cannot be determined because the attribute of this command is in both on and off states in the relevant selection.
その他の値any other value コマンドを off に設定します。Sets the command to off.

COleCmdUI:: SetTextCOleCmdUI::SetText

コマンドのテキスト名またはステータス文字列を返すには、この関数を呼び出します。Call this function to return a text name or status string for a command.

virtual void SetText(LPCTSTR lpszText);


コマンドで使用されるテキストへのポインター。A pointer to the text to be used with the command.

関連項目See also

CCmdUI クラスCCmdUI Class
階層図Hierarchy Chart