COleServerDoc クラス

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

OLE サーバードキュメントの基底クラスです。

構文

class AFX_NOVTABLE COleServerDoc : public COleLinkingDoc

メンバー

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

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

パブリックメソッド

名前	説明
COleServerDoc::ActivateDocObject	関連付けられている DocObject ドキュメントをアクティブにします。
COleServerDoc::ActivateInPlace	インプレース編集のためにドキュメントをアクティブにします。
COleServerDoc::D eactivateAndUndo	サーバーのユーザーインターフェイスを非アクティブ化します。
COleServerDoc::D iscardUndoState	元に戻す状態情報を破棄します。
COleServerDoc::GetClientSite	基になる `IOleClientSite` インターフェイスへのポインターを取得します。
COleServerDoc::GetEmbeddedItem	文書全体を表す項目へのポインターを返します。
COleServerDoc::GetItemClipRect	インプレース編集用の現在のクリッピング四角形を返します。
COleServerDoc::GetItemPosition	インプレース編集のために、コンテナーアプリケーションのクライアント領域を基準とした現在位置の四角形を返します。
COleServerDoc::GetZoomFactor	ズーム係数をピクセル単位で返します。
COleServerDoc::IsDocObject	ドキュメントが DocObject であるかどうかを判断します。
COleServerDoc::IsEmbedded	ドキュメントがコンテナードキュメントに埋め込まれているか、スタンドアロンで実行されているかを示します。
COleServerDoc::IsInPlaceActive	項目が現在アクティブ化されている場合は TRUE を返します。
COleServerDoc::NotifyChanged	ユーザーがドキュメントを変更したことをコンテナーに通知します。
COleServerDoc::NotifyClosed	ユーザーがドキュメントを閉じたことをコンテナーに通知します。
COleServerDoc::NotifyRename	ユーザーがドキュメントの名前を変更したことをコンテナーに通知します。
COleServerDoc::NotifySaved	ユーザーがドキュメントを保存したことをコンテナーに通知します。
COleServerDoc::OnDeactivate	ユーザーが所定の場所でアクティブ化された項目を非アクティブ化するときに、フレームワークによって呼び出されます。
COleServerDoc::OnDeactivateUI	インプレースアクティブ化のために作成されたコントロールやその他のユーザーインターフェイス要素を破棄するためにフレームワークによって呼び出されます。
COleServerDoc::OnDocWindowActivate	コンテナーのドキュメントフレームウィンドウがアクティブ化または非アクティブ化されたときにフレームワークによって呼び出されます。
COleServerDoc::OnResizeBorder	コンテナーアプリケーションのフレームウィンドウまたはドキュメントウィンドウのサイズが変更されたときにフレームワークによって呼び出されます。
COleServerDoc::OnShowControlBars	インプレース編集のためにコントロールバーを表示または非表示にするためにフレームワークによって呼び出されます。
COleServerDoc::OnUpdateDocument	埋め込みアイテムであるサーバードキュメントが保存されるときにフレームワークによって呼び出され、コンテナーのアイテムのコピーが更新されます。
COleServerDoc::RequestPositionChange	インプレース編集フレームの位置を変更します。
COleServerDoc::SaveEmbedding	ドキュメントを保存するようにコンテナーアプリケーションに指示します。
COleServerDoc::ScrollContainerBy	コンテナードキュメントをスクロールします。
COleServerDoc::UpdateAllItems	ユーザーがドキュメントを変更したことをコンテナーに通知します。

保護メソッド

名前	説明
COleServerDoc::CreateInPlaceFrame	インプレース編集用のフレームウィンドウを作成するためにフレームワークによって呼び出されます。
COleServerDoc::D estroyInPlaceFrame	インプレース編集のためにフレームウィンドウを破棄するためにフレームワークによって呼び出されます。
COleServerDoc::GetDocObjectServer	この関数をオーバーライドして新しい `CDocObjectServer` オブジェクトを作成し、このドキュメントが DocObject コンテナーであることを示します。
COleServerDoc::OnClose	コンテナーがドキュメントを閉じるよう要求したときにフレームワークによって呼び出されます。
COleServerDoc::OnExecOleCmd	指定したコマンドを実行するか、コマンドのヘルプを表示します。
COleServerDoc::OnFrameWindowActivate	コンテナーのフレームウィンドウがアクティブ化または非アクティブ化されたときにフレームワークによって呼び出されます。
COleServerDoc::OnGetEmbeddedItem	埋め込みアイテムを取得するために使用される、ドキュメント全体を表す `COleServerItem` を取得するために呼び出されます。実装が必要です。
COleServerDoc::OnReactivateAndUndo	インプレース編集中に行われた変更を元に戻すためにフレームワークによって呼び出されます。
COleServerDoc::OnSetHostNames	コンテナーが埋め込みオブジェクトのウィンドウタイトルを設定するときにフレームワークによって呼び出されます。
COleServerDoc::OnSetItemRects	コンテナーアプリケーションのウィンドウ内にインプレース編集フレームウィンドウを配置するためにフレームワークによって呼び出されます。
COleServerDoc::OnShowDocument	ドキュメントを表示または非表示にするためにフレームワークによって呼び出されます。

解説

サーバードキュメントには COleServerItem オブジェクトを含めることができます。これは、埋め込みアイテムまたはリンクされたアイテムへのサーバーインターフェイスを表します。埋め込みアイテムを編集するためにコンテナーによってサーバーアプリケーションが起動されると、その項目は独自のサーバードキュメントとして読み込まれます。 COleServerDoc オブジェクトには、ドキュメント全体で構成される 1 つの COleServerItem オブジェクトだけが含まれます。リンクされたアイテムを編集するためにコンテナーによってサーバーアプリケーションが起動されると、既存のドキュメントがディスクから読み込まれます。リンクされたアイテムを示すために、ドキュメントのコンテンツの一部が強調表示されます。

COleServerDoc オブジェクトには、 COleClientItem クラスの項目を含めることもできます。これにより、コンテナーサーバーアプリケーションを作成できます。フレームワークには、COleServerItem オブジェクトにサービスを提供しながら、COleClientItem項目を適切に格納する機能が用意されています。

サーバーアプリケーションがリンクをサポートしていない場合、サーバードキュメントには、埋め込みオブジェクト全体をドキュメントとして表すサーバー項目が常に 1 つだけ含まれます。サーバーアプリケーションがリンクをサポートしている場合は、選択内容がクリップボードにコピーされるたびにサーバー項目を作成する必要があります。

COleServerDocを使用するには、そこからクラスを派生させ、OnGetEmbeddedItem メンバー関数を実装します。これにより、サーバーは埋め込み項目をサポートできます。 COleServerItemからクラスを派生させ、ドキュメント内の項目を実装し、そのクラスのオブジェクトをOnGetEmbeddedItemから返します。

リンクされたアイテムをサポートするために、 COleServerDoc は OnGetLinkedItem メンバー関数を提供します。ドキュメントアイテムを独自に管理する方法がある場合は、既定の実装を使用するか、オーバーライドすることができます。

アプリケーションでサポートされているサーバードキュメントの種類ごとに 1 つの COleServerDoc派生クラスが必要です。たとえば、サーバーアプリケーションでワークシートとグラフがサポートされている場合は、2 つの COleServerDoc派生クラスが必要です。

サーバーの詳細については、「 Servers: サーバーの実装」を参照してください。

継承階層

COleServerDoc

要件

ヘッダー: afxole.h

COleServerDoc::ActivateDocObject

関連付けられている DocObject ドキュメントをアクティブにします。

void ActivateDocObject();

解説

既定では、 COleServerDoc はアクティブなドキュメント (DocObject とも呼ばれます) をサポートしていません。このサポートを有効にするには、 GetDocObjectServer およびクラス CDocObjectServer を参照してください。

COleServerDoc::ActivateInPlace

インプレース編集のためにアイテムをアクティブにします。

BOOL ActivateInPlace();

戻り値

成功した場合は 0 以外。それ以外の場合は 0。項目が完全に開かれていることを示します。

解説

この関数は、インプレースアクティブ化に必要なすべての操作を実行します。インプレースフレームウィンドウを作成し、アクティブ化して項目に合わせてサイズを設定し、共有メニューやその他のコントロールを設定し、項目をビューにスクロールして、フォーカスをインプレースフレームウィンドウに設定します。

この関数は、 COleServerItem::OnShow の既定の実装によって呼び出されます。アプリケーションがインプレースアクティブ化の別の動詞 (Play など) をサポートしている場合は、この関数を呼び出します。

COleServerDoc::COleServerDoc

OLE システム DLL に接続せずに COleServerDoc オブジェクトを構築します。

COleServerDoc();

解説

OLE との通信を開くには、 COleLinkingDoc::Register を呼び出す必要があります。アプリケーションで COleTemplateServer を使用している場合は、COleLinkingDocのOnNewDocument、OnOpenDocument、およびOnSaveDocumentの実装によってCOleLinkingDoc::Registerが呼び出されます。

COleServerDoc::CreateInPlaceFrame

フレームワークは、この関数を呼び出して、インプレース編集用のフレームウィンドウを作成します。

virtual COleIPFrameWnd* CreateInPlaceFrame(CWnd* pParentWnd);

パラメーター

pParentWnd
コンテナーアプリケーションの親ウィンドウへのポインター。

戻り値

インプレースフレームウィンドウへのポインター。失敗した場合は NULL。

解説

既定の実装では、ドキュメントテンプレートで指定された情報を使用してフレームを作成します。使用されるビューは、ドキュメント用に作成された最初のビューです。このビューは、元のフレームから一時的にデタッチされ、新しく作成されたフレームにアタッチされます。

これは、高度なオーバーライドが可能です。

COleServerDoc::D eactivateAndUndo

アプリケーションが元に戻すをサポートし、ユーザーがアイテムをアクティブ化した後、編集する前に [元に戻す] を選択した場合は、この関数を呼び出します。

BOOL DeactivateAndUndo();

戻り値

正常に完了した場合はゼロ以外、それ以外の場合は 0 です。

解説

コンテナーアプリケーションが Microsoft Foundation クラスライブラリを使用して記述されている場合、この関数を呼び出すと、 COleClientItem::OnDeactivateAndUndo が呼び出され、サーバーのユーザーインターフェイスが非アクティブ化されます。

COleServerDoc::D estroyInPlaceFrame

フレームワークはこの関数を呼び出して、インプレースフレームウィンドウを破棄し、インプレースアクティブ化の前にサーバーアプリケーションのドキュメントウィンドウをその状態に戻します。

virtual void DestroyInPlaceFrame(COleIPFrameWnd* pFrameWnd);

パラメーター

pFrameWnd
破棄するインプレースフレームウィンドウへのポインター。

解説

これは、高度なオーバーライドが可能です。

COleServerDoc::D iscardUndoState

ユーザーが元に戻すことができない編集操作を実行する場合は、この関数を呼び出して、コンテナーアプリケーションで元に戻す状態情報を破棄するように強制します。

BOOL DiscardUndoState();

戻り値

正常に完了した場合はゼロ以外、それ以外の場合は 0 です。

解説

この関数は、元に戻すをサポートするサーバーが、使用できない元に戻す状態情報によって使用されるリソースを解放できるように提供されます。

COleServerDoc::GetClientSite

基になる IOleClientSite インターフェイスへのポインターを取得します。

LPOLECLIENTSITE GetClientSite() const;

戻り値

基になる IOleClientSite インターフェイスへのポインターを取得します。

COleServerDoc::GetDocObjectServer

新しい CDocObjectServer 項目を作成し、その項目へのポインターを返すには、この関数をオーバーライドします。

virtual CDocObjectServer* GetDocObjectServer(LPOLEDOCUMENTSITE pDocSite);

パラメーター

pDocSite
このドキュメントをサーバーに接続する IOleDocumentSite インターフェイスへのポインター。

戻り値

CDocObjectServerへのポインター。操作が失敗した場合は NULL。

解説

DocObject サーバーがアクティブ化されると、NULL 以外のポインターの戻り値は、クライアントが DocObject をサポートできることを示します。既定の実装では、NULL が返されます。

DocObjects をサポートするドキュメントの一般的な実装では、新しい CDocObjectServer オブジェクトを割り当てて呼び出し元に返すだけです。次に例を示します。

CDocObjectServer* CMFCOleServerDoc::GetDocObjectServer(LPOLEDOCUMENTSITE pSite)
{
   return new CDocObjectServer(this, pSite);
}

COleServerDoc::GetEmbeddedItem

ドキュメント全体を表す項目へのポインターを取得するには、この関数を呼び出します。

COleServerItem* GetEmbeddedItem();

戻り値

ドキュメント全体を表す項目へのポインター。操作が失敗した場合は NULL。

解説

既定の実装のない仮想関数 COleServerDoc::OnGetEmbeddedItem を呼び出します。

COleServerDoc::GetItemClipRect

GetItemClipRectメンバー関数を呼び出して、編集中のアイテムのクリッピング四角形座標を取得します。

void GetItemClipRect(LPRECT lpClipRect) const;

パラメーター

lpClipRect
項目のクリッピング四角形座標を受け取る RECT 構造体または CRect オブジェクトへのポインター。

解説

座標は、コンテナーアプリケーションウィンドウのクライアント領域を基準としたピクセル単位です。

クリッピング四角形の外側に描画を行うべきではありません。通常、描画は自動的に制限されます。この関数を使用して、ユーザーがドキュメントの表示部分の外側にスクロールしたかどうかを確認します。その場合は、 ScrollContainerBy の呼び出しによって、必要に応じてコンテナードキュメントをスクロールします。

COleServerDoc::GetItemPosition

GetItemPosition メンバー関数を呼び出して、編集中のアイテムの座標を取得します。

void GetItemPosition(LPRECT lpPosRect) const;

パラメーター

lpPosRect
アイテムの座標を受け取る RECT 構造体または CRect オブジェクトへのポインター。

解説

座標は、コンテナーアプリケーションウィンドウのクライアント領域を基準としたピクセル単位です。

項目の位置を現在のクリッピング四角形と比較して、画面上で項目が表示される (または表示されない) 範囲を決定できます。

COleServerDoc::GetZoomFactor

GetZoomFactorメンバー関数は、インプレース編集用にアクティブ化されたアイテムの "ズーム係数" を決定します。

BOOL GetZoomFactor(
    LPSIZE lpSizeNum = NULL,
    LPSIZE lpSizeDenom = NULL,
    LPCRECT lpPosRect = NULL) const;

パラメーター

lpSizeNum
ズーム係数の分子を保持するクラス CSize のオブジェクトへのポインター。 NULL にすることができます。

lpSizeDenom
ズーム係数の分母を保持するクラス CSize のオブジェクトへのポインター。 NULL にすることができます。

lpPosRect
項目の新しい位置を記述するクラス CRect のオブジェクトへのポインター。この引数が NULL の場合、関数は項目の現在位置を使用します。

戻り値

アイテムがインプレース編集のためにアクティブ化され、そのズーム係数が 100% (1:1) 以外の場合は 0 以外。それ以外の場合は 0。

解説

ズーム係数 (ピクセル単位) は、アイテムのサイズと現在の範囲の比率です。コンテナーアプリケーションが項目のエクステントを設定していない場合は、その自然なエクステント ( COleServerItem::OnGetExtent によって決定されます) が使用されます。

この関数は、最初の 2 つの引数を、項目の "ズーム係数" の分子と分母に設定します。項目が正しく編集されていない場合、関数はこれらの引数を既定値の 100% (または 1:1) に設定し、0 を返します。詳細については、テクニカルノート 40、 MFC/OLE インプレースサイズ変更とズームを参照してください。

COleServerDoc::IsDocObject

ドキュメントが DocObject であるかどうかを判断します。

BOOL IsDocObject() const;

戻り値

ドキュメントが DocObject の場合は TRUE。それ以外の場合は FALSE。

COleServerDoc::IsEmbedded

IsEmbedded メンバー関数を呼び出して、ドキュメントがコンテナーに埋め込まれたオブジェクトを表しているかどうかを判断します。

BOOL IsEmbedded() const;

戻り値

COleServerDoc オブジェクトがコンテナーに埋め込まれたオブジェクトを表すドキュメントの場合は 0 以外、それ以外の場合は 0。

解説

ファイルから読み込まれたドキュメントは埋め込まれませんが、コンテナーアプリケーションによってリンクとして操作される可能性があります。コンテナードキュメントに埋め込まれているドキュメントは、埋め込まれていると見なされます。

COleServerDoc::IsInPlaceActive

IsInPlaceActiveメンバー関数を呼び出して、アイテムが現在インプレースアクティブ状態であるかどうかを判断します。

BOOL IsInPlaceActive() const;

戻り値

COleServerDoc オブジェクトがアクティブな場合は 0 以外、それ以外の場合は 0。

COleServerDoc::NotifyChanged

この関数を呼び出して、ドキュメントに接続されているすべてのリンクアイテムにドキュメントが変更されたことを通知します。

void NotifyChanged();

解説

通常、この関数は、ユーザーがサーバードキュメントのディメンションなどのグローバル属性を変更した後に呼び出します。 OLE アイテムが自動リンクを使用してドキュメントにリンクされている場合、変更を反映するようにアイテムが更新されます。 Microsoft Foundation クラスライブラリで記述されたコンテナーアプリケーションでは、COleClientItemの OnChange メンバー関数が呼び出されます。

Note

この関数は、OLE 1 との互換性のために含まれています。新しいアプリケーションでは、 UpdateAllItems を使用する必要があります。

COleServerDoc::NotifyClosed

この関数を呼び出して、ドキュメントが閉じられたことをコンテナーに通知します。

void NotifyClosed();

解説

ユーザーが [ファイル] メニューから [閉じる] コマンドを選択すると、 NotifyClosed は COleServerDocの OnCloseDocument メンバー関数の実装によって呼び出されます。 Microsoft Foundation クラスライブラリで記述されたコンテナーアプリケーションでは、COleClientItemの OnChange メンバー関数が呼び出されます。

COleServerDoc::NotifyRename

ユーザーがサーバードキュメントの名前を変更した後、この関数を呼び出します。

void NotifyRename(LPCTSTR lpszNewName);

パラメーター

lpszNewName
サーバードキュメントの新しい名前を指定する文字列へのポインター。これは通常、完全修飾パスです。

解説

ユーザーが [ファイル] メニューから [名前を付けて保存] コマンドを選択すると、 NotifyRename は COleServerDocの OnSaveDocument メンバー関数の実装によって呼び出されます。この関数は OLE システム DLL に通知し、次にコンテナーに通知します。 Microsoft Foundation クラスライブラリで記述されたコンテナーアプリケーションでは、COleClientItemの OnChange メンバー関数が呼び出されます。

COleServerDoc::NotifySaved

ユーザーがサーバードキュメントを保存した後、この関数を呼び出します。

void NotifySaved();

解説

ユーザーが [ファイル] メニューから [保存] コマンドを選択すると、NotifySavedは、OnSaveDocument の実装COleServerDocによって呼び出されます。この関数は OLE システム DLL に通知し、次にコンテナーに通知します。 Microsoft Foundation クラスライブラリで記述されたコンテナーアプリケーションでは、COleClientItemの OnChange メンバー関数が呼び出されます。

COleServerDoc::OnClose

コンテナーがサーバードキュメントを閉じる要求を行ったときにフレームワークによって呼び出されます。

virtual void OnClose(OLECLOSE dwCloseOption);

パラメーター

dwCloseOption
列挙 OLECLOSE の値。このパラメーターには、次のいずれかの値を指定できます。

OLECLOSE_SAVEIFDIRTY ファイルが変更されている場合は保存されます。
OLECLOSE_NOSAVE ファイルは保存されずに閉じられます。
OLECLOSE_PROMPTSAVE ファイルが変更されている場合は、ファイルの保存を求めるメッセージが表示されます。

解説

既定の実装では、 CDocument::OnCloseDocumentが呼び出されます。

詳細と追加の値については、Windows SDK の「 OLECLOSE 」を参照してください。

COleServerDoc::OnDeactivate

ユーザーが現在アクティブな埋め込みまたはリンクされたアイテムを非アクティブ化すると、フレームワークによって呼び出されます。

virtual void OnDeactivate();

解説

この関数は、コンテナーアプリケーションのユーザーインターフェイスを元の状態に復元し、インプレースアクティブ化のために作成されたメニューやその他のコントロールを破棄します。

元に戻す状態情報は、この時点で無条件に解放する必要があります。

詳細については、 Activation に関する記事を参照してください。

COleServerDoc::OnDeactivateUI

ユーザーがインプレースでアクティブ化されたアイテムを非アクティブ化するときに呼び出されます。

virtual void OnDeactivateUI(BOOL bUndoable);

パラメーター

bUndoable
編集の変更を元に戻すことができるかどうかを指定します。

解説

この関数は、コンテナーアプリケーションのユーザーインターフェイスを元の状態に戻し、インプレースアクティブ化のために作成されたメニューやその他のコントロールを非表示にします。

フレームワークは常に bUndoable を FALSE に設定します。サーバーで元に戻す操作がサポートされていて、元に戻すことができる操作がある場合は、 bUndoable を TRUE に設定して基底クラスの実装を呼び出します。

COleServerDoc::OnDocWindowActivate

フレームワークは、この関数を呼び出して、インプレース編集のためにドキュメントウィンドウをアクティブ化または非アクティブ化します。

virtual void OnDocWindowActivate(BOOL bActivate);

パラメーター

bActivate
ドキュメントウィンドウをアクティブ化するか非アクティブ化するかを指定します。

解説

既定の実装では、必要に応じてフレームレベルのユーザーインターフェイス要素を削除または追加します。アイテムを含むドキュメントがアクティブ化または非アクティブ化されたときに追加のアクションを実行する場合は、この関数をオーバーライドします。

詳細については、 Activation に関する記事を参照してください。

COleServerDoc::OnExecOleCmd

フレームワークはこの関数を呼び出して、指定されたコマンドを実行するか、コマンドのヘルプを表示します。

virtual HRESULT OnExecOleCmd(
    const GUID* pguidCmdGroup,
    DWORD nCmdID,
    DWORD nCmdExecOpt,
    VARIANTARG* pvarargIn,
    VARIANTARG* pvarargOut);

パラメーター

pguidCmdGroup
一連のコマンドを識別する GUID へのポインター。既定のコマンドグループを示すには NULL を指定できます。

nCmdID
実行するコマンドです。 pguidCmdGroup で識別されるグループに含まれている必要があります。

nCmdExecOut
オブジェクトがコマンドを実行する方法。OLECMDEXECOPT 列挙型の次の値の 1 つ以上。

OLECMDEXECOPT_DODEFAULT

OLECMDEXECOPT_PROMPTUSER

OLECMDEXECOPT_DONTPROMPTUSER

OLECMDEXECOPT_SHOWHELP

pvarargIn
コマンドの入力引数を含む VARIANTARG へのポインター。 NULL にすることができます。

pvarargOut
コマンドから出力戻り値を受け取る VARIANTARG へのポインター。 NULL にすることができます。

戻り値

成功した場合はS_OKを返します。それ以外の場合は、次のいずれかのエラーコードが表示されます。

Value	説明
E_UNEXPECTED	予期しないエラーが発生しました
E_FAIL	エラーが発生しました
E_NOTIMPL	MFC 自体がコマンドの変換とディスパッチを試みる必要があることを示します
OLECMDERR_E_UNKNOWNGROUP	pguidCmdGroup は NULL 以外ですが、認識されたコマンドグループは指定しません
OLECMDERR_E_NOTSUPPORTED	nCmdID がグループ pguidCmdGroup の有効なコマンドとして認識されない
OLECMDERR_DISABLED	nCmdID によって識別されるコマンドは無効であり、実行できません
OLECMDERR_NOHELP	呼び出し元は、 nCmdID で識別されるコマンドに関するヘルプを要求しましたがヘルプは使用できません
OLECMDERR_CANCELED	ユーザーが実行を取り消した

解説

COleCmdUI を使用して、DocObject ユーザーインターフェイスコマンドのその他のプロパティを有効、更新、および設定できます。コマンドが初期化されたら、 OnExecOleCmdを使用してコマンドを実行できます。

フレームワークは、OLE ドキュメントコマンドを翻訳およびディスパッチする前に関数を呼び出します。標準の OLE ドキュメントコマンドを処理するためにこの関数をオーバーライドする必要はありませんが、独自のカスタムコマンドを処理したり、パラメーターを受け取ったり結果を返したりするコマンドを処理する場合は、この関数にオーバーライドを指定する必要があります。

ほとんどのコマンドは引数や戻り値を受け取りません。ほとんどのコマンドの場合、呼び出し元は pvarargIn および pvarargOut の NULL を渡すことができます。入力値を想定するコマンドの場合、呼び出し元は VARIANTARG 変数を宣言して初期化し、 pvarargIn 内の変数へのポインターを渡すことができます。 1 つの値を必要とするコマンドの場合、引数を VARIANTARG に直接格納し、関数に渡すことができます。サポートされている型 ( IDispatch や SAFEARRAY など) のいずれかを使用して、VARIANTARG 内に複数の引数をパッケージ化する必要があります。

同様に、コマンドが引数を返す場合、呼び出し元は VARIANTARG を宣言し、それをVT_EMPTYに初期化し、そのアドレスを pvarargOut で渡すことが期待されます。コマンドから 1 つの値が返された場合、オブジェクトはその値を pvarargOut に直接格納できます。 VARIANTARG に適した方法で複数の出力値をパッケージ化する必要があります。

この関数の基底クラスの実装では、コマンドターゲットに関連付けられているOLE_COMMAND_MAP構造体について説明し、適切なハンドラーにコマンドをディスパッチしようとします。基底クラスの実装は、引数または戻り値を受け取らないコマンドでのみ機能します。引数または戻り値を受け入れるコマンドを処理する必要がある場合は、この関数をオーバーライドし、 pvarargIn および pvarargOut パラメーターを自分で操作する必要があります。

COleServerDoc::OnFrameWindowActivate

フレームワークは、コンテナーアプリケーションのフレームウィンドウがアクティブ化または非アクティブ化されるときに、この関数を呼び出します。

virtual void OnFrameWindowActivate(BOOL bActivate);

パラメーター

bActivate
フレームウィンドウをアクティブにするか非アクティブにするかを指定します。

解説

既定の実装では、フレームウィンドウが存在する可能性があるヘルプモードが取り消されます。フレームウィンドウのアクティブ化または非アクティブ化時に特別な処理を実行する場合は、この関数をオーバーライドします。

詳細については、 Activation に関する記事を参照してください。

COleServerDoc::OnGetEmbeddedItem

コンテナーアプリケーションがサーバーアプリケーションを呼び出して埋め込みアイテムを作成または編集するときにフレームワークによって呼び出されます。

virtual COleServerItem* OnGetEmbeddedItem() = 0;

戻り値

ドキュメント全体を表す項目へのポインター。操作が失敗した場合は NULL。

解説

既定の実装はありません。ドキュメント全体を表すアイテムを返すには、この関数をオーバーライドする必要があります。この戻り値は、 COleServerItem派生クラスのオブジェクトである必要があります。

COleServerDoc::OnReactivateAndUndo

フレームワークは、ユーザーが、その場でアクティブ化、変更、その後非アクティブ化されたアイテムに加えられた変更を元に戻す場合に、この関数を呼び出します。

virtual BOOL OnReactivateAndUndo();

戻り値

正常終了した場合は 0 以外を返します。それ以外の場合は 0 を返します。

解説

既定の実装では、エラーを示す FALSE を返す以外は何も行われません。

アプリケーションで元に戻す機能がサポートされている場合は、この関数をオーバーライドします。通常は、元に戻す操作を実行し、 ActivateInPlaceを呼び出して項目をアクティブにします。コンテナーアプリケーションが Microsoft Foundation Class Library で記述されている場合、 COleClientItem::ReactivateAndUndo を呼び出すと、この関数が呼び出されます。

COleServerDoc::OnResizeBorder

フレームワークは、コンテナーアプリケーションのフレームウィンドウのサイズが変更されたときに、この関数を呼び出します。

virtual void OnResizeBorder(
    LPCRECT lpRectBorder,
    LPOLEINPLACEUIWINDOW lpUIWindow,
    BOOL bFrame);

パラメーター

lpRectBorder
RECT構造体または境界線の座標を指定するCRect オブジェクトへのポインター。

lpUIWindow
現在のインプレース編集セッションを所有するクラス IOleInPlaceUIWindow のオブジェクトへのポインター。

bFrame
lpUIWindowがコンテナーアプリケーションの最上位フレームウィンドウを指す場合は TRUE、コンテナーアプリケーションのドキュメントレベルのフレームウィンドウlpUIWindow の場合は FALSE。

解説

この関数は、新しいウィンドウサイズに応じて、ツールバーやその他のユーザーインターフェイス要素のサイズを変更および調整します。

詳細については、Windows SDK の「 IOleInPlaceUIWindow 」を参照してください。

これは、高度なオーバーライドが可能です。

COleServerDoc::OnSetHostNames

コンテナーがこのドキュメントのホスト名を設定または変更するときにフレームワークによって呼び出されます。

virtual void OnSetHostNames(
    LPCTSTR lpszHost,
    LPCTSTR lpszHostObj);

パラメーター

lpszHost
コンテナーアプリケーションの名前を指定する文字列へのポインター。

lpszHostObj
ドキュメントのコンテナーの名前を指定する文字列へのポインター。

解説

既定の実装では、このドキュメントを参照するすべてのビューのドキュメントタイトルが変更されます。

アプリケーションが別のメカニズムを使用してタイトルを設定する場合は、この関数をオーバーライドします。

COleServerDoc::OnSetItemRects

フレームワークは、この関数を呼び出して、コンテナーアプリケーションのフレームウィンドウ内にインプレース編集フレームウィンドウを配置します。

virtual void OnSetItemRects(
    LPCRECT lpPosRect,
    LPCRECT lpClipRect);

パラメーター

lpPosRect
コンテナーアプリケーションのクライアント領域に対するインプレースフレームウィンドウの位置を指定する、 RECT 構造体または CRect オブジェクトへのポインター。

lpClipRect
コンテナーアプリケーションのクライアント領域に対するインプレースフレームウィンドウのクリッピング四角形を指定する、 RECT 構造体または CRect オブジェクトへのポインター。

解説

必要に応じて、ビューのズーム係数を更新するには、この関数をオーバーライドします。

この関数は通常、 RequestPositionChange 呼び出しに応答して呼び出されますが、インプレースアイテムの位置変更を要求するためにコンテナーによっていつでも呼び出すことができます。

COleServerDoc::OnShowControlBars

フレームワークは、この関数を呼び出して、 pFrameWnd で識別されるフレームウィンドウに関連付けられたサーバーアプリケーションのコントロールバーを表示または非表示にします。

virtual void OnShowControlBars(
    CFrameWnd* pFrameWnd,
    BOOL bShow);

パラメーター

pFrameWnd
コントロールバーを非表示または表示する必要があるフレームウィンドウへのポインター。

bShow
コントロールバーを表示するか非表示にするかを指定します。

解説

既定の実装では、そのフレームウィンドウによって所有されているすべてのコントロールバーが列挙され、非表示または表示されます。

COleServerDoc::OnShowDocument

フレームワークは、サーバードキュメントを非表示または表示する必要がある場合に、 OnShowDocument 関数を呼び出します。

virtual void OnShowDocument(BOOL bShow);

パラメーター

bShow
ドキュメントへのユーザーインターフェイスを表示するか非表示にするかを指定します。

解説

bShow が TRUE の場合、既定の実装では、必要に応じてサーバーアプリケーションがアクティブ化され、コンテナーアプリケーションがそのウィンドウをスクロールして項目が表示されるようになります。 bShow が FALSE の場合、既定の実装では、OnDeactivateの呼び出しによって項目が非アクティブ化され、最初のフレームウィンドウを除き、ドキュメント用に作成されたすべてのフレームウィンドウが破棄または非表示になります。表示されているドキュメントが残っていない場合、既定の実装ではサーバーアプリケーションが非表示になります。

COleServerDoc::OnUpdateDocument

複合ドキュメントに埋め込まれた項目であるドキュメントを保存するときに、フレームワークによって呼び出されます。

virtual BOOL OnUpdateDocument();

戻り値

ドキュメントが正常に更新された場合は 0 以外。それ以外の場合は 0。

解説

既定の実装では、 COleServerDoc::NotifySaved および COleServerDoc::SaveEmbedding メンバー関数を呼び出し、ドキュメントをクリーンとしてマークします。埋め込み項目を更新するときに特別な処理を実行する場合は、この関数をオーバーライドします。

COleServerDoc::RequestPositionChange

コンテナーアプリケーションで項目の位置を変更するには、このメンバー関数を呼び出します。

void RequestPositionChange(LPCRECT lpPosRect);

パラメーター

lpPosRect
RECT構造体または項目の新しい位置を含むCRect オブジェクトへのポインター。

解説

この関数は、通常、インプレースアクティブアイテムのデータが変更されたときに( UpdateAllItemsと組み合わせて)呼び出されます。この呼び出しの後、コンテナーは、 OnSetItemRectsを呼び出すことによって変更を実行する場合と実行しない場合があります。結果の位置は、要求された位置とは異なる場合があります。

COleServerDoc::SaveEmbedding

この関数を呼び出して、埋め込みオブジェクトを保存するようにコンテナーアプリケーションに指示します。

void SaveEmbedding();

解説

この関数は、 OnUpdateDocumentから自動的に呼び出されます。この関数により、項目がディスク上で更新されるため、通常は特定のユーザーアクションの結果としてのみ呼び出されることに注意してください。

COleServerDoc::ScrollContainerBy

ScrollContainerBy メンバー関数を呼び出して、コンテナードキュメントをピクセル単位でスクロールsizeScroll。

BOOL ScrollContainerBy(CSize sizeScroll);

パラメーター

sizeScroll
コンテナードキュメントがスクロールする距離を示します。

戻り値

正常終了した場合は 0 以外を返します。それ以外の場合は 0 を返します。

解説

正の値は、下にスクロールして右にスクロールすることを示します。負の値は、上下にスクロールすることを示します。

COleServerDoc::UpdateAllItems

この関数を呼び出して、ドキュメントに接続されているすべてのリンクアイテムにドキュメントが変更されたことを通知します。

void UpdateAllItems(
    COleServerItem* pSender,
    LPARAM lHint = 0L,
    CObject* pHint = NULL,
    DVASPECT nDrawAspect = DVASPECT_CONTENT);

パラメーター

pSender
ドキュメントを変更したアイテムへのポインター。すべてのアイテムを更新する場合は NULL。

lHint
変更に関する情報を格納します。

pHint
変更に関する情報を格納しているオブジェクトへのポインター。

nDrawAspect
アイテムの描画方法を決定します。これは DVASPECT 列挙型の値です。このパラメーターには、次のいずれかの値を指定できます。

DVASPECT_CONTENT項目は、コンテナー内の埋め込みオブジェクトとして表示できるように表されます。
DVASPECT_THUMBNAILアイテムは、閲覧ツールに表示できるように、"サムネイル" 表現でレンダリングされます。
DVASPECT_ICON項目はアイコンで表されます。
DVASPECT_DOCPRINT項目は、[ファイル] メニューの [印刷] コマンドを使用して印刷されたかのように表されます。

解説

通常、この関数は、ユーザーがサーバードキュメントを変更した後に呼び出します。 OLE アイテムが自動リンクを使用してドキュメントにリンクされている場合、変更を反映するようにアイテムが更新されます。 Microsoft Foundation クラスライブラリで記述されたコンテナーアプリケーションでは、COleClientItemの OnChange メンバー関数が呼び出されます。

この関数は、pHint、lHint、および nDrawAspect を渡して、送信アイテムを除くドキュメントの各アイテムに対してOnUpdateメンバー関数を呼び出します。これらのパラメーターを使用して、ドキュメントに加えられた変更に関する情報をアイテムに渡します。 lHintを使用して情報をエンコードするかCObject派生クラスを定義して変更に関する情報を格納し、pHint を使用してそのクラスのオブジェクトを渡すことができます。 COleServerItem派生クラスのOnUpdateメンバー関数をオーバーライドして、プレゼンテーションが変更されたかどうかに応じて各項目の更新を最適化します。

次の方法で共有

COleServerDoc クラス

構文

メンバー

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

パブリック メソッド

保護メソッド

解説

継承階層

要件

COleServerDoc::ActivateDocObject

解説

COleServerDoc::ActivateInPlace

戻り値

解説

COleServerDoc::COleServerDoc

解説

COleServerDoc::CreateInPlaceFrame

パラメーター

戻り値

解説

COleServerDoc::D eactivateAndUndo

戻り値

解説

COleServerDoc::D estroyInPlaceFrame

パラメーター

解説

COleServerDoc::D iscardUndoState

戻り値

解説

COleServerDoc::GetClientSite

戻り値

COleServerDoc::GetDocObjectServer

パラメーター

戻り値

解説

COleServerDoc::GetEmbeddedItem

戻り値

解説

COleServerDoc::GetItemClipRect

パラメーター

解説

COleServerDoc::GetItemPosition

パラメーター

解説

COleServerDoc::GetZoomFactor

パラメーター

戻り値

解説

COleServerDoc::IsDocObject

戻り値

COleServerDoc::IsEmbedded

戻り値

解説

COleServerDoc::IsInPlaceActive

戻り値

COleServerDoc::NotifyChanged

解説

COleServerDoc::NotifyClosed

解説

COleServerDoc::NotifyRename

パラメーター

解説

COleServerDoc::NotifySaved

解説

COleServerDoc::OnClose

パラメーター

解説

COleServerDoc::OnDeactivate

解説

COleServerDoc::OnDeactivateUI

パラメーター

解説

COleServerDoc::OnDocWindowActivate

パラメーター

解説

COleServerDoc::OnExecOleCmd

パラメーター

戻り値

解説

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

パブリックメソッド