CDocTemplate::GetDocString

2011-08-09

ドキュメントの型に関連付けられている文字列を取得します。

virtual BOOL GetDocString(
   CString& rString,
   enum DocStringIndex index 
) const;

パラメーター

rString
関数から戻るときに文字列を保持する CString オブジェクトへの参照。
index
ドキュメントの型を表す文字列から取得する部分文字列へのインデックス。このパラメーターには、次のいずれかの値を指定できます。
- CDocTemplate::windowTitle アプリケーションウィンドウのタイトルバーに表示されている名前 (例 : "Microsoft Excel") です。 SDI アプリケーション用のドキュメントテンプレートの場合だけ有効です。
- CDocTemplate::docName 既定のドキュメント名のルート (例 : "Sheet") です。 [ファイル] メニューの [新規作成] を選択したとき、このルートに数字を付加すると、この型の新しいドキュメントの既定の名前 (例 : "Sheet1" または "Sheet2") となります。指定されていない場合、"Untitled" を使います。
- CDocTemplate::fileNewName ドキュメントの型名です。アプリケーションが 1 つ以上のドキュメントの型をサポートしていると、この文字列が [ファイル新規作成] ダイアログボックスに表示されます (例 : "Worksheet")。指定されていないと、[ファイル] メニューの [新規作成] を選択したときにドキュメントの型を特定できません。
- CDocTemplate::filterName ドキュメントの型の説明と、この型のドキュメントを検索するときのフィルターとなるワイルドカードです。この文字列は、[ファイルを開く] ダイアログボックスの [ファイルの種類] ボックスに表示されます (例 : "Worksheets (*.xls)")。指定されていないと、[ファイル] メニューの [開く] を選択したときにドキュメントの型を特定できません。
- CDocTemplate::filterExt この型のドキュメントのファイル拡張子 (例 : ".xls") です。指定されていないと、[ファイル] メニューの [開く] を選択したときにドキュメントの型を特定できません。
- CDocTemplate::regFileTypeId Windows が管理している登録データベースに格納されるドキュメントの型の識別子です。この文字列は内部でだけ使用されます (例 : "ExcelWorksheet")。指定されていないと、Windows のファイルマネージャーは、このドキュメントの型を登録できません。
- CDocTemplate::regFileTypeName 登録データベースに格納されるドキュメントの型の名前です。この文字列は、登録データベースをアクセスするアプリケーションのダイアログボックスに表示されます (例 : "Microsoft Excel Worksheet")。

戻り値

指定した部分文字列を見つけた場合は 0 以外を返します。それ以外の場合は 0 を返します。

解説

ドキュメントの型を示す特定の部分文字列を取得します。これらの部分文字列を含む文字列は、ドキュメントテンプレートに格納され、アプリケーションのリソースファイルで派生する文字列から作成されます。フレームワークは、アプリケーションのユーザーインターフェイスで必要な文字列を取得するために、この関数を呼び出します。アプリケーションのドキュメントのファイル名の拡張子を指定していれば、フレームワークは、Windows の登録データベースのエントリに加えるときにもこの関数を呼び出します。これにより、Windows のファイルマネージャーからドキュメントを開くことができるようになります。

CDocTemplate から独自のクラスを派生させたときだけ、この関数を呼び出すようにしてください。