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

要件

ヘッダー: 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
オン/オフトグル コマンドを設定する状態を決定する値。 値は次のとおりです。

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

COleCmdUI::SetText

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

virtual void SetText(LPCTSTR lpszText);

パラメーター

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

関連項目

CCmdUI クラス
階層図