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

[アーティクル]
06/16/2023

Note

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

IOleCommandTarget インターフェイスを使用すると、オブジェクトとそのコンテナーがコマンドを互いにディスパッチできます。たとえば、オブジェクトのツールバーには、Print、Print Preview、Save、New、Zoom などのコマンドのボタンが含まれている場合があります。このようなオブジェクトが IOleCommandTarget をサポートするコンテナーに埋め込まれている場合、オブジェクトはそのボタンを有効にし、ユーザーがそれらをクリックした場合を処理するためのコマンドをコンテナーに転送できます。埋め込みオブジェクトがそれ自体を印刷する必要があるコンテナーでは、埋め込みオブジェクトの IOleCommandTarget インターフェイスを介してコマンドを送信することで、この要求を行うことができます。

IOleCommandTarget は、クライアントがサーバー上のメソッドを呼び出すために使用するという点でオートメーションに似たインターフェイスです。ただし、IOleCommandTarget を使用すると、通常負荷が高い IDispatch の Invoke メソッドをプログラマが使用する必要がないため、オートメーションインターフェイスを介して呼び出しを行うことに伴うオーバーヘッドが節約されます。

MFC では、IOleCommandTarget インターフェイスは、Active ドキュメントコンテナーがサーバーにコマンドをディスパッチできるようにするために、Active ドキュメントサーバーによって使用されます。 Active ドキュメントサーバークラス CDocObjectServerItem では、MFC インターフェイスマップ (「テクニカルノート 38: MFC/OLE IUnknown の実装」を参照) を使用して、IOleCommandTarget インターフェイスを実装します。

IOleCommandTarget は、COleFrameHook クラスにも実装されています。 COleFrameHook は、インプレース編集コンテナーのフレームウィンドウ機能を実装する、ドキュメントに未記載の MFC クラスです。 COleFrameHook も、MFC インターフェイスマップを使用して、IOleCommandTarget インターフェイスを実装します。 COleFrameHook の IOleCommandTarget の実装は、OLE コマンドを COleDocObjectItem から派生した Active ドキュメントコンテナーに転送します。これにより、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 コマンドを受け取ると、MFC はアプリケーションの OLE コマンドマップ内で、要求されたコマンドのコマンド ID とコマンドグループの検索を試みます。一致が見つかった場合、要求されたコマンドの ID を含む WM_COMMAND メッセージがコマンドマップを含むアプリケーションにディスパッチされます (以下の説明を ON_OLECMD 参照してください)。このように、アプリケーションにディスパッチされた OLE コマンドは、MFC によってWM_COMMAND メッセージに変換されます。次に、WM_COMMAND メッセージは、MFC 標準コマンドルーティングアーキテクチャを使用して、アプリケーションのメッセージマップを介してルーティングされます。

メッセージマップとは異なり、MFC OLE コマンドマップは ClassWizard ではサポートされません。 MFC 開発者は、OLE コマンドマップのサポートと OLE コマンドマップのエントリを手動で追加する必要があります。 OLE コマンドマップは、Active ドキュメントがコンテナー内でインプレースアクティブである時点で WM_COMMAND メッセージルーティングチェーン内にある任意のクラス内で MFC Active ドキュメントサーバーに追加できます。これらのクラスには、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 へのポインター。このパラメーターは、標準 OLE コマンドグループの場合は NULL です。

olecmdid
呼び出されるコマンドの OLE コマンド ID。

id
この OLE コマンドが呼び出されたときに、コマンドマップを含むアプリケーションに送信される WM_COMMAND メッセージの ID。

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

例

次の例は、OLECMDID_PRINT OLE コマンドを処理する OLE コマンド処理機能を MFC Active ドキュメントサーバーに追加する方法を示しています。この例では、AppWizard を使用して、Active ドキュメントサーバーである MFC アプリケーションを生成していることを前提としています。

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

Note

CView 派生クラスを使用するのは、これが WM_COMMAND メッセージルーティングチェーン内にある Active ドキュメントサーバーのクラスの 1 つであるためです。
```
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()
```

OLECMDID_PRINT は標準 OLE コマンド ID なので、afxdocob.h 内に定義されている標準 OLE コマンドのマクロの 1 つを ON_OLECMD マクロの代わりに使用できます。 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();
}

Share via

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

MFC OLE コマンドマップ

OLE コマンドマップのマクロ

例

関連項目

フィードバック

フィードバック

その他のリソース

Share via

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

MFC OLE コマンド マップ

OLE コマンド マップのマクロ

例

関連項目

フィードバック

フィードバック

その他のリソース

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

MFC OLE コマンドマップ

OLE コマンドマップのマクロ