CDocObjectServerItem クラス

OLE サーバー動詞を DocObject サーバー用に実装します。

構文

class CDocObjectServerItem : public COleServerItem

メンバー

保護されたコンストラクター

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

パブリック メソッド

名前	説明
CDocObjectServerItem::GetDocument	アイテムを含むドキュメントへのポインターを取得します。

保護メソッド

名前	説明
CDocObjectServerItem::OnDoVerb	動詞を実行するために呼び出されます。
CDocObjectServerItem::OnHide	フレームワークが DocObject 項目を非表示にしようとした場合に例外をスローします。
CDocObjectServerItem::OnShow	DocObject 項目をインプレースアクティブにするためにフレームワークによって呼び出されます。 アイテムが DocObject でない場合は、 COleServerItem::OnShow を呼び出します。

解説

CDocObjectServerItem は、オーバーライド可能なメンバー関数 ( OnHide、 OnDoVerb、および OnShow を定義します。

CDocObjectServerItemを使用するには、COleServerDoc派生クラスの OnGetEmbeddedItem オーバーライドが新しいCDocObjectServerItem オブジェクトを返すようにします。 アイテム内の機能を変更する必要がある場合は、独自の CDocObjectServerItem派生クラスの新しいインスタンスを作成できます。

DocObjects の詳細については、「MFC リファレンス」の「CDocObjectServer および COleCmdUI」を参照。

継承階層

CObject

CCmdTarget

CDocItem

COleServerItem

CDocObjectServerItem

要件

Header: afxdocob.h

CDocObjectServerItem::CDocObjectServerItem

CDocObjectServerItem オブジェクトを構築します。

CDocObjectServerItem(COleServerDoc* pServerDoc, BOOL bAutoDelete);

パラメーター

pServerDoc
新しい DocObject 項目を含むドキュメントへのポインター。

bAutoDelete
オブジェクトへのリンクが解放されたときにオブジェクトを削除できるかどうかを示します。 CDocObjectServerItem オブジェクトがドキュメントのデータの不可欠な部分である場合は、引数を FALSE に設定します。 オブジェクトが、フレームワークによって削除できるドキュメントのデータ内の範囲を識別するために使用されるセカンダリ構造である場合は、TRUE に設定します。

CDocObjectServerItem::GetDocument

アイテムを含むドキュメントへのポインターを取得します。

COleServerDoc* GetDocument() const;

戻り値

アイテムを含むドキュメントへのポインター。アイテムがドキュメントの一部でない場合は NULL。

解説

これにより、 CDocObjectServerItem コンストラクターに引数として渡したサーバー ドキュメントにアクセスできます。

CDocObjectServerItem::OnDoVerb

指定された動詞を実行するためにフレームワークによって呼び出されます。

virtual void OnDoVerb(LONG iVerb);

パラメーター

iVerb
実行する動詞を指定します。 指定できる値については、Windows SDK IOleObject::D oVerb を参照してください。

解説

既定の実装では、アイテムが DocObject で、OLEIVERB_INPLACEACTIVATEまたはOLEIVERB_SHOWが指定されている場合、 OnShow メンバー関数を呼び出します。 項目が DocObject でない場合、または別の動詞が指定されている場合、既定の実装では COleServerItem::OnDoVerb が呼び出されます。

CDocObjectServerItem::OnHide

アイテムを非表示にするためにフレームワークによって呼び出されます。

virtual void OnHide();

解説

項目が DocObject の場合、既定の実装では例外がスローされます。 アクティブな DocObject アイテムはビュー全体を取得するため、非表示にすることはできません。 非表示にするには、DocObject 項目を非アクティブ化する必要があります。 アイテムが DocObject でない場合、既定の実装では COleServerItem::OnHide が呼び出されます。

CDocObjectServerItem::OnShow

DocObject 項目をインプレースアクティブにするようサーバー アプリケーションに指示するために、フレームワークによって呼び出されます。

virtual void OnShow();

解説

項目が DocObject でない場合、既定の実装では COleServerItem::OnShow が呼び出されます。 DocObject アイテムを開くときに特別な処理を実行する場合は、この関数をオーバーライドします。

関連項目

COleServerItem クラス
階層図
CDocObjectServer クラス
COleDocObjectItem クラス