CDocument クラス

ユーザーが定義するドキュメント クラスの基本機能が用意されています。

class CDocument : public CCmdTarget

メンバー

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

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

パブリック メソッド

名前	説明
CDocument::AddView	ドキュメントにビューをアタッチします。
CDocument::BeginReadChunks	チャンク読み取りを初期化します。
CDocument::CanCloseFrame	高度なオーバーライド可能関数です。ドキュメントを表示しているフレーム ウィンドウが閉じられる直前に呼び出されます。
CDocument::ClearChunkList	チャンク リストをクリアします。
CDocument::ClearPathName	ドキュメント オブジェクトのパスをクリアします。
CDocument::DeleteContents	ドキュメントのクリーンアップを実行します。
CDocument::FindChunk	指定した GUID のチャンクを検索します。
CDocument::GetAdapter	ポインターを取得するには戻り値 IDocument のインターフェイスを実装します。
CDocument::GetDocTemplate	ドキュメントの型に対応するドキュメント テンプレートへのポインターを返します。
CDocument::GetFile	希望する CFile オブジェクトへのポインターを返します。
CDocument::GetFirstViewPosition	ビューのリストの最初の位置を返します。反復の始めに使います。
CDocument::GetNextView	ドキュメントに関連付けられているビューのリストを反復処理します。
CDocument::GetPathName	ドキュメントのデータ ファイルのパスを返します。
CDocument::GetThumbnail	サムネイルを表示するためにサムネイル プロバイダーで使用されるビットマップを作成するために呼び出されます。
CDocument::GetTitle	ドキュメントのタイトルを返します。
CDocument::InitializeSearchContent	検索コンテンツを検索ハンドラー用に初期化するために呼び出されます。
CDocument::IsModified	最後に保存されてからドキュメントが変更されているかどうかを示します。
CDocument::IsSearchAndOrganizeHandler	CDocument のオブジェクトのこのインスタンスが検索の&に整理するハンドラーを作成したかどうかを示します。
CDocument::LoadDocumentFromStream	ストリームからドキュメント データを読み込むために呼び出されます。
CDocument::OnBeforeRichPreviewFontChanged	リッチ プレビューのフォントを変更する前に呼び出されます。
CDocument::OnChangedViewList	ドキュメントのビューが追加されるか、ドキュメントからビューが削除されるときに呼び出されます。
CDocument::OnCloseDocument	ドキュメントを閉じるために呼び出されます。
CDocument::OnCreatePreviewFrame	リッチ プレビュー用のプレビュー フレームを作成する必要があるときに、フレームワークにより呼び出されます。
CDocument::OnDocumentEvent	ドキュメント イベントに応答して、フレームワークにより呼び出されます。
CDocument::OnDrawThumbnail	サムネイルのコンテンツを描画するには、派生クラスでこのメソッドをオーバーライドします。
CDocument::OnLoadDocumentFromStream	ストリームからドキュメント データを読み込む必要があるときに、フレームワークによって呼び出されます。
CDocument::OnNewDocument	新しいドキュメントを作成するために呼び出されます。
CDocument::OnOpenDocument	既存のドキュメントを開くために呼び出されます。
CDocument::OnPreviewHandlerQueryFocus	GetFocus 関数を呼び出して取得された HWND を返すように、プレビュー ハンドラーに命令します。
CDocument::OnPreviewHandlerTranslateAccelerator	プレビュー ハンドラーを実行しているプロセスのメッセージ ポンプから渡されたキーストロークを処理するように、プレビュー ハンドラーに命令します。
CDocument::OnRichPreviewBackColorChanged	リッチ プレビューの背景色を変更したときに呼び出されます。
CDocument::OnRichPreviewFontChanged	リッチ プレビューのフォントが変更されたときに呼び出されます。
CDocument::OnRichPreviewSiteChanged	リッチ プレビューのサイトが変更されたときに呼び出されます。
CDocument::OnRichPreviewTextColorChanged	リッチ プレビューのテキストの色を変更したときに呼び出されます。
CDocument::OnSaveDocument	ドキュメントをディスクに保存するために呼び出されます。
CDocument::OnUnloadHandler	プレビュー ハンドラーがアンロードされるときに、フレームワークにより呼び出されます。
CDocument::PreCloseFrame	フレーム ウィンドウが閉じられるときに呼び出されます。
CDocument::ReadNextChunkValue	次のチャンク値を読み取ります。
CDocument::ReleaseFile	ほかのアプリケーションが利用できるようにファイルを解放します。
CDocument::RemoveChunk	指定された GUID とチャンクを削除します。
CDocument::RemoveView	ドキュメントからビューを切り離します。
CDocument::ReportSaveLoadException	高度なオーバーライド可能関数です。例外の発生により、オープン、または保存の操作が完了できないときに呼び出されます。
CDocument::SaveModified	高度なオーバーライド可能関数です。ドキュメントを保存するかどうかを問い合わせるために、呼び出されます。
CDocument::SetChunkValue	チャンク値を設定します。
CDocument::SetModifiedFlag	最後に保存されてからドキュメントが変更されているかどうかを示すフラグを設定します。
CDocument::SetPathName	ドキュメントのデータ ファイルのパスを設定します。
CDocument::SetTitle	ドキュメントのタイトルを設定します。
CDocument::UpdateAllViews	ドキュメントが変更されたことをすべてのビューに通知します。

プロテクト メソッド

名前	説明
CDocument::OnFileSendMail	ドキュメントを添付してメール メッセージを送信します。
CDocument::OnUpdateFileSendMail	メールがサポートされているときに、Send Mail コマンドを有効にします。

パブリック データ メンバー

名前	説明
CDocument::m_bGetThumbnailMode	CDocument のオブジェクトが縮小表示の dllhost によって作成されたことを指定します。CView::OnDraw で確認する必要があります。
CDocument::m_bPreviewHandlerMode	CDocument のオブジェクトが Rich Previewの prevhost によって作成されたことを指定します。CView::OnDraw で確認する必要があります。
CDocument::m_bSearchMode	CDocument のオブジェクトがインデクサーまたはそのほかの検索のアプリケーションで作成されたことを指定します。
CDocument::m_clrRichPreviewBackColor	リッチ プレビュー ウィンドウの背景色を指定します。この色はホストにより設定されます。
CDocument::m_clrRichPreviewTextColor	リッチ プレビュー ウィンドウの前景色を指定します。この色はホストにより設定されます。
CDocument::m_lfRichPreviewFont	リッチ プレビュー ウィンドウのテキスト フォントを指定します。このフォント情報はホストにより設定されます。

解説

ドキュメントは、ユーザーがファイルを開く]コマンドで一般に開き、ファイルの保存]コマンドと保存データの単位を表します。

CDocument は、ドキュメントの作成、読み込み、および保存などの標準的な操作をサポートします。フレームワークは CDocumentによって定義されるインターフェイスを使用してドキュメントを操作します。

アプリケーションでは、ドキュメントの種類をサポートできます。; たとえば、アプリケーション、およびテキスト ドキュメントの両方をサポートする場合があります。ドキュメントの種類に関連するドキュメント テンプレートは、; は、ドキュメント テンプレート リソース (たとえば、メニュー、アイコン、またはアクセラレータ テーブル) ドキュメント内のその型に使用されるかを指定します。各ドキュメントは CDocTemplate に関連付けられたオブジェクトへのポインターが格納されます。

ユーザーは関連付けられている [CW2CT] のオブジェクトを介してドキュメントと対話します。ビューは、ドキュメントのフレーム ウィンドウでイメージを表示およびドキュメントの操作として、ユーザー入力を解釈します。ドキュメントは、関連付けられた複数のビューを持つことができます。ユーザーがドキュメントのウィンドウを開くと、フレームワークはビューを作成し、ドキュメントにアタッチします。ドキュメント テンプレートによってドキュメントの種類を表示する際にどのようなビュー、およびフレーム ウィンドウを使用するかを指定します。

ドキュメントは、フレームワーク標準のコマンド ルーティングの一部であり、標準的なユーザー インターフェイスのコンポーネントからコマンドを受け取ります (ファイルの保存のメニュー項目など)。ドキュメントは、アクティブなビューによって転送されたコマンドを受け取ります。ドキュメントが特定のコマンドを処理し、それを管理するドキュメント テンプレートに送られます。

ドキュメントのデータが変更されると、ビューには、これらの変更を反映する必要があります。CDocument は、このような変更の概要を通知できるため、ビュー、必要に応じて、自身を再描画できるように UpdateAllViews のメンバー関数を提供します。フレームワークは、ユーザーが閉じる前に変更されたファイルを保存するよう要求します。

一般的なアプリケーションのドキュメントを実装するには、以下を行う必要があります:

• ドキュメントの種類ごとに CDocument からクラスを派生します。

• 各ドキュメントにデータを格納するメンバー変数を追加します。

• ドキュメントのデータを読み取って変更するためのメンバー関数を実装します。ドキュメントのビューは、これらのメンバー関数の最も重要なユーザーです。

• ディスクに対してドキュメントのデータを読み書きするには、ドキュメント クラスの CObject::Serialize のメンバー関数をオーバーライドします。

CDocument がメールのサポート (MAPI) がある場合は、メールしてドキュメントの送信をサポートします。MAPIMFC の MAPI のサポートおよび" "を参照してください。

CDocumentの詳細については、[シリアル化]、ドキュメント/ビュー アーキテクチャのトピックと ドキュメント/ビューの作成を参照してください。

継承階層

CObject

CCmdTarget

CDocument

必要条件

ヘッダー: afxwin.h

参照

関連項目

CCmdTarget クラス

階層図

CCmdTarget クラス

CView クラス

CDocTemplate クラス

概念

MFC MDIDOCVW サンプル

MFC SNAPVW サンプル

MFC NPP サンプル