COleCmdUI クラス

  • [アーティクル]

アプリケーションの IOleCommandTargetドリブンの機能に関連するユーザー インターフェイス オブジェクトの状態を更新するメソッドを MFC に提供します。

構文

class COleCmdUI : public CCmdUI

メンバー

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

名前 説明
COleCmdUI::COleCmdUI COleCmdUI オブジェクトを構築します。

パブリック メソッド

名前 説明
COleCmdUI::Enable enable コマンド フラグを設定またはクリアします。
COleCmdUI::SetCheck オン/オフ切り替えコマンドの状態を設定します。
COleCmdUI::SetText コマンドのテキスト名または状態文字列を返します。

解説

DocObjects に対して有効になっていないアプリケーションでは、ユーザーがアプリケーション内のメニューを表示すると、MFC はUPDATE_COMMAND_UI通知を処理します。 各通知には、特定のコマンドの状態を反映するために操作できる CCmdUI オブジェクトが与えられます。 ただし、アプリケーションが DocObjects に対して有効になっている場合、MFC は通知UPDATE_OLE_COMMAND_UI処理し、 COleCmdUI オブジェクトを割り当てます。

COleCmdUI を使用すると、DocObject は、コンテナーのユーザー インターフェイス (FileNew、Open、Print など) で生成されたコマンドを受け取り、コンテナーが DocObject のユーザー インターフェイスで生成されたコマンドを受け取ることができます。 IDispatchを使用して同じコマンドをディスパッチすることもできますが、IOleCommandTargetは、通常は引数を使用せず、型情報も含まない標準のコマンド セットに依存するため、クエリと実行の簡単な方法を提供します。 COleCmdUI を使用して、DocObject ユーザー インターフェイス コマンドのその他のプロパティを有効、更新、および設定できます。 コマンドを呼び出す場合は、 COleServerDoc::OnExecOleCmd を呼び出します。

DocObjects の詳細については、 CDocObjectServer および CDocObjectServerItem を参照してください。

継承階層

CCmdUI

COleCmdUI

要件

Header: afxdocob.h

COleCmdUI::COleCmdUI

特定のユーザー インターフェイス コマンドに関連付けられた COleCmdUI オブジェクトを構築します。

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

パラメーター

rgCmds
指定された GUID に関連付けられているサポートされているコマンドの一覧。 OLECMD構造体は、コマンドをコマンド フラグに関連付けます。

cCmds
rgCmds 内のコマンドの数。

pGroup
一連のコマンドを識別する GUID へのポインター。

解説

COleCmdUI オブジェクトは、メニュー項目やコントロール バー ボタンなどの DocObject ユーザー インターフェイス オブジェクトを更新するためのプログラムインターフェイスを提供します。 ユーザー インターフェイス オブジェクトは、 COleCmdUI オブジェクトを使用して有効、無効、チェック、クリアを行うことができます。

COleCmdUI::Enable

この関数を呼び出して、 COleCmdUI オブジェクトのコマンド フラグを OLECOMDF_ENABLED に設定します。これにより、コマンドが使用可能で有効になっていることをインターフェイスに通知したり、コマンド フラグをクリアしたりできます。

virtual void Enable(BOOL bOn);

パラメーター

ボン
COleCmdUI オブジェクトに関連付けられているコマンドを有効または無効にするかどうかを示します。 0 以外の場合、コマンドが有効になります。0 を指定すると、コマンドが無効になります。

COleCmdUI::SetCheck

オン/オフトグル コマンドの状態を設定するには、この関数を呼び出します。

virtual void SetCheck(int nCheck);

パラメーター

nCheck
オン/オフトグル コマンドを設定する状態を決定する値。 値は次のとおりです。

Value 説明
1 コマンドをオンに設定します。
2 コマンドを不確定に設定します。このコマンドの属性は、関連する選択のオンとオフの両方の状態にあるため、状態を特定できません。
その他の値 コマンドを off に設定します。

COleCmdUI::SetText

コマンドのテキスト名または状態文字列を返すには、この関数を呼び出します。

virtual void SetText(LPCTSTR lpszText);

パラメーター

lpszText
コマンドで使用するテキストへのポインター。

関連項目

CCmdUI クラス
階層図