次の方法で共有


CDocTemplate::GetDocString

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

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

パラメーター

  • rString
    関数から制御が戻るときの文字列を含む CString のオブジェクトへの参照。

  • index
    ドキュメントの種類を示す文字列から取得した部分文字列のインデックス。このパラメーターには、次のいずれかの値を指定できます。

    • アプリケーション ウィンドウのタイトル バー (たとえば、「Microsoft Excel」) で使用されるCDocTemplate::windowTitle の名前。SDI アプリケーションのドキュメント テンプレートでのみを表示します。

    • CDocTemplate::docName は既定のドキュメントの名前 (「シート」) をルートします。このルートは、この数と型の新しいドキュメントの既定の名前では、ユーザーが新しいファイル]メニューからコマンドを選択するたびに使用されます (たとえば、「Sheet1」または「Sheet2」)。指定されていない「」、題既定値として使用されます。

    • このドキュメントの種類のCDocTemplate::fileNewName の名前。アプリケーションがドキュメントの種類をサポートする場合は、この文字列は、ファイルの新しいダイアログ ボックス (「」) ワークシートに表示されます。指定しなかった場合には、ドキュメントの種類は、ファイルの新しいコマンドを使用してアクセスできません。

    • こののドキュメントの種類とワイルドカードのフィルターに一致したドキュメントのCDocTemplate::filterName 型の説明。この文字列は、ファイルを開く]ダイアログ ボックスの型のドロップダウン リストのファイルが表示されます (たとえば、「ワークシート (*.xls) 」)。指定しなかった場合には、ドキュメントの種類は、ファイルを開く]コマンドを使用してアクセスできません。

    • このドキュメントのCDocTemplate::filterExt 拡張機能の 型 (たとえば、「新規」)。指定しなかった場合には、ドキュメントの種類は、ファイルを開く]コマンドを使用してアクセスできません。

    • Windows で保持される登録データベースに格納するドキュメントの種類のCDocTemplate::regFileTypeId の識別子。この文字列は内部でのみ使用します (「」) ExcelWorksheet です。指定しなかった場合には、ドキュメントの種類は、Windows のファイル マネージャーに登録することはできません。

    • 登録データベースに格納するドキュメントの種類のCDocTemplate::regFileTypeName の名前。この文字列は登録データベース (たとえば、「Microsoft Excel ワークシート」) にアクセスするアプリケーションのダイアログ ボックスに表示されることがあります。

戻り値

指定された部分が見つかった場合は、; それ以外の場合は 0。

解説

ドキュメントの種類を説明する特定の部分文字列を取得するには、この関数を呼び出します。The string これらの部分文字列を含めると、ドキュメント テンプレートに格納され、アプリケーションのリソース ファイルの文字列から派生します。フレームワークは、アプリケーションのユーザー インターフェイスに必要な文字列を取得するときにこの関数を呼び出します。アプリケーションのドキュメントについて、拡張子を指定した場合、フレームワークは、エントリを Windows 登録データベースに追加するときにこの関数を呼び出します; これは、ドキュメントに Windows のファイル マネージャーから開くことができます。

CDocTemplateから独自のクラスを派生させる場合にのみ、この関数を呼び出します。

必要条件

ヘッダー: afxwin.h

参照

関連項目

CDocTemplate クラス

階層図

CMultiDocTemplate::CMultiDocTemplate

CSingleDocTemplate::CSingleDocTemplate

CWinApp::RegisterShellFileTypes