テクニカルノート 71: MFC IOleCommandTarget の実装

[アーティクル]
08/09/2011

注意

次のテクニカルノートは、最初にオンラインドキュメントの一部とされてから更新されていません。結果として、一部のプロシージャおよびトピックが最新でないか、不正になります。最新の情報について、オンラインドキュメントのキーワードで関係のあるトピックを検索することをお勧めします。

オブジェクトとそのコンテナーは、IOleCommandTarget インターフェイスを通じてコマンドをディスパッチします。たとえば、[印刷]、[印刷プレビュー]、[上書き保存]、[新規作成]、[ズーム] などのボタンをツールバーに配置したオブジェクトがあるとします。このオブジェクトの埋め込み先コンテナーで IOleCommandTarget がサポートされる場合は、オブジェクトのツールバーボタンが有効になり、ボタンがクリックされるとコマンドがコンテナーに送られます。埋め込み先オブジェクト自身が印刷コマンドを処理する場合は、埋め込みオブジェクトの IOleCommandTarget インターフェイスを通じて、コンテナーから印刷を要求するコマンドが送られます。

クライアントがサーバー上のメソッドを呼び出すときに使用するという点で、IOleCommandTarget インターフェイスは、オートメーションインターフェイスに似ています。ただし、IOleCommandTarget では、プログラマが IDispatch の Invoke メソッドを使用する必要がないため、オートメーションインターフェイス経由の呼び出しに伴うオーバーヘッドがありません。通常、このメソッドは大量のリソースを必要とします。

MFC (Microsoft Foundation Class) では、Active ドキュメントサーバー側で IOleCommandTarget インターフェイスを使用して、Active ドキュメントコンテナーからのコマンドを受け取ります。アクティブドキュメントサーバークラスは、CDocObjectServerItem、MFC インターフェイスマップが使用されます (を参照してくださいTN038:MFC/OLE IUnknown の実装) を実装するのには、IOleCommandTargetインターフェイス。

IOleCommandTarget は COleFrameHook クラスでも実装されています。 COleFrameHook は、埋め込み先編集コンテナーのフレームウィンドウ機能を実装する非公開 MFC クラスです。 COleFrameHook でも、MFC インターフェイスマップを使用して IOleCommandTarget インターフェイスを実装します。 COleFrameHook の IOleCommandTarget は COleDocObjectItem から派生した Active ドキュメントコンテナーに OLE コマンドを転送します。このインターフェイスを通じて、どの MFC Active ドキュメントコンテナーでも、包含している Active ドキュメントサーバーからのメッセージを受け取ることができます。

MFC OLE コマンドマップ

MFC 開発者は、MFC OLE コマンドマップを使用して IOleCommandTarget を利用できます。 OLE コマンドでは、メッセージマップと同じように、OLE コマンドをコマンドマップの所属先クラスのメンバー関数にマップできます。実際にはコマンドマップに、処理するコマンドの OLE コマンドグループ、OLE コマンド、および OLE コマンドの受信時に送る WM_COMMAND メッセージのコマンド ID を指定するマクロを記述します。 MFC には、標準 OLE コマンド用の定義済みマクロが多数用意されています。 Microsoft Office アプリケーション用にデザインされた標準 OLE コマンドの一覧については、docobj.h で定義されている OLECMDID 列挙定数を参照してください。

OLE コマンドマップを持つ MFC アプリケーションが OLE コマンドを受け取ると、このコマンドのコマンド ID とコマンドグループが OLE コマンドマップで検索されます。一致するコマンド ID とコマンドグループが見つかると、WM_COMMAND メッセージが、要求されたコマンドの ID によってコマンドマップの所属先アプリケーションにディスパッチされます。以下の ON_OLECMD の説明を参照してください。このように、アプリケーションにディスパッチされた OLE コマンドは、MFC によって WM_COMMAND メッセージに変換されます。この WM_COMMAND メッセージは、MFC の標準コマンドルーティングアーキテクチャに基づき、アプリケーションのメッセージマップを通じて転送されます。

メッセージマップとは異なり、MFC OLE コマンドマップは ClassWizard でサポートされていません。 MFC 開発者は、OLE コマンドマップのサポートと OLE コマンドマップエントリを手作業で追加する必要があります。 OLE コマンドマップは、Active ドキュメントがコンテナー内の埋め込み先編集が有効な状態にあるときに、MFC Active ドキュメントサーバーの WM_COMMAND メッセージルーティングチェインにある任意のクラスに追加できます。このようなクラスとしては、アプリケーションの CWinApp、CView、CDocument、および COleIPFrameWnd 派生クラスがあります。 Active ドキュメントコンテナーで OLE コマンドマップを追加できるのは、COleDocObjectItem 派生クラスだけです。また、Active ドキュメントコンテナーでは、WM_COMMAND メッセージが COleDocObjectItem 派生クラスのメッセージマップだけにディスパッチされます。

OLE コマンドマップマクロ

以下のマクロを使用して、コマンドマップ機能をクラスに追加します。

DECLARE_OLECMD_MAP ()

このマクロは、コマンドマップの所属先クラスのクラス宣言 (通常はヘッダーファイル) に入れます。

BEGIN_OLECMD_MAP(theClass, baseClass)

theClass
コマンドマップの所属先クラスの名前。
baseClass
コマンドマップの所属先クラスの基本クラスの名前。

コマンドマップの開始位置を示します。このマクロは、コマンドマップの所属先クラスの実装ファイルで使用します。

END_OLECMD_MAP()

コマンドマップの終了位置を示します。このマクロは、コマンドマップの所属先クラスの実装ファイルで使用します。このマクロは必ず BEGIN_OLECMD_MAP マクロの後に置きます。

ON_OLECMD(pguid, olecmdid, id)

pguid
OLE コマンドのコマンドグループのグローバル一意識別子 (GUID: Globally Unique Identifier) へのポインター。標準 OLE コマンドグループの場合は、このパラメーターを NULL にします。
olecmdid
呼び出されるコマンドの OLE コマンド ID。
id
この OLE コマンドが呼び出されたときにコマンドマップの所属先アプリケーションに送る WM_COMMAND メッセージの ID。

コマンドマップで ON_OLECMD マクロを使用して、処理する OLE コマンドのエントリを追加します。アプリケーションに送られた OLE コマンドは、指定された WM_COMMAND メッセージに変換され、標準の MFC コマンドルーティングアーキテクチャに基づき、アプリケーションのメッセージマップを通じて転送されます。

使用例

次のコードは、OLE コマンド OLECMDID_PRINT を処理する OLE コマンド処理機能を MFC Active ドキュメントサーバーに追加する例です。この例では、Active ドキュメントサーバー側 MFC アプリケーションが AppWizard で生成されています。

CView 派生クラスのヘッダーファイルで、DECLARE_OLECMD_MAP マクロをクラス宣言に追加します。

注意

Active ドキュメントサーバーの WM_COMMAND メッセージルーティングチェイン上にあるクラスとして、CView 派生クラスを使用します。
```
class CMyServerView : public CView
{
protected: // create from serialization only
   CMyServerView();
   DECLARE_DYNCREATE(CMyServerView)
   DECLARE_OLECMD_MAP()
. . .
};
```
CView 派生クラスの実装ファイルに BEGIN_OLECMD_MAP マクロと END_OLECMD_MAP マクロを追加します。
```
BEGIN_OLECMD_MAP(CMyServerView, CView)

END_OLECMD_MAP()
```
OLE の標準印刷コマンドを処理するには、ON_OLECMD マクロをコマンドマップに追加して、標準印刷コマンドの OLE コマンド ID と WM_COMMAND ID の ID_FILE_PRINT を指定します。 ID_FILE_PRINT は、AppWizard で生成した MFC アプリケーションが使用する標準印刷コマンド ID です。
```
BEGIN_OLECMD_MAP(CMyServerView, CView)
   ON_OLECMD(NULL,OLECMDID_PRINT,ID_FILE_PRINT)
END_OLECMD_MAP()
```

ON_OLECMD マクロの代わりに、afxdocob.h で定義されている標準 OLE コマンドマクロも使用できます。これは、OLECMDID_PRINT が OLE の標準コマンド ID であるためです。 ON_OLECMD_PRINT マクロの機能は、上の ON_OLECMD マクロと同じです。

コンテナーアプリケーションがこのサーバーに対して、サーバーの IOleCommandTarget インターフェイス経由で OLECMDID_PRINT コマンドを送ると、サーバーの MFC 印刷コマンドハンドラーが呼び出され、アプリケーションを印刷します。上の手順で追加した印刷コマンドを呼び出す Active ドキュメントコンテナーのコードは、次のようになります。

void CContainerCntrItem::DoOleCmd()
{
   IOleCommandTarget *pCmd = NULL;
   HRESULT hr = E_FAIL;
   OLECMD ocm={OLECMDID_PRINT, 0};

   hr = m_lpObject->QueryInterface(IID_IOleCommandTarget,reinterpret_cast<void**>(&pCmd));
   if(FAILED(hr))
      return;

   hr = pCmd->QueryStatus(NULL, 1, &ocm, NULL);
   if(SUCCEEDED(hr) && (ocm.cmdf & OLECMDF_ENABLED))
   {
      //Command is available and enabled so call it
      COleVariant vIn;
      COleVariant vOut;
      hr = pCmd->Exec(NULL, OLECMDID_PRINT,
 OLECMDEXECOPT_DODEFAULT, &vIn, &vOut);
      ASSERT(SUCCEEDED(hr));
   }
   pCmd->Release();
}

参照

その他の技術情報

番号順テクニカルノート

カテゴリ別テクニカルノート

次の方法で共有

テクニカルノート 71: MFC IOleCommandTarget の実装

MFC OLE コマンドマップ

OLE コマンドマップマクロ

使用例

参照

その他の技術情報

その他のリソース

次の方法で共有

テクニカル ノート 71: MFC IOleCommandTarget の実装

MFC OLE コマンド マップ

OLE コマンド マップ マクロ

使用例

参照

その他の技術情報

その他のリソース

テクニカルノート 71: MFC IOleCommandTarget の実装

MFC OLE コマンドマップ

OLE コマンドマップマクロ