ITextTemplatingEngineHost インターフェイス

[アーティクル]
10/28/2012

テキストテンプレートを変換するホストのインターフェイス。これは、ディレクティブプロセッサで使用でき、テキストテンプレートからアクセスすることもできます。

名前空間: Microsoft.VisualStudio.TextTemplating
アセンブリ: Microsoft.VisualStudio.TextTemplating.Interfaces.10.0 (Microsoft.VisualStudio.TextTemplating.Interfaces.10.0.dll 内)

構文

'宣言
<CLSCompliantAttribute(True)> _
Public Interface ITextTemplatingEngineHost

[CLSCompliantAttribute(true)]
public interface ITextTemplatingEngineHost

[CLSCompliantAttribute(true)]
public interface class ITextTemplatingEngineHost

[<CLSCompliantAttribute(true)>]
type ITextTemplatingEngineHost =  interface end

public interface ITextTemplatingEngineHost

ITextTemplatingEngineHost 型で公開されるメンバーは以下のとおりです。

プロパティ

	名前	説明
	StandardAssemblyReferences	アセンブリ参照の一覧を取得します。
	StandardImports	名前空間の一覧を取得します。
	TemplateFile	処理されるテキストテンプレートのパスとファイル名を取得します。

このページのトップへ

メソッド

	名前	説明
	GetHostOption	指定されたオプションの値を取得するために、エンジンによって呼び出されます。不明な場合は null を返します。
	LoadIncludeText	部分テキストテンプレートファイルを含める要求に対応するテキストを取得します。
	LogErrors	変換エンジンからエラーおよび警告のコレクションを受け取ります。
	ProvideTemplatingAppDomain	生成された変換クラスを実行するためのアプリケーションドメインを提供します。
	ResolveAssemblyReference	ホストがアセンブリの場所に関する追加情報を提供できるようにします。
	ResolveDirectiveProcessor	指定された表示名のディレクティブプロセッサの型を返します。
	ResolveParameterValue	ディレクティブプロセッサのパラメーターがテンプレートテキストに指定されていない場合に、パラメーターの値を解決します。
	ResolvePath	ファイル名または相対パスを指定すると、ホストによって完全なパスが指定されるようにします。
	SetFileExtension	生成されるテキスト出力で予測されるファイル名の拡張子をホストに指示します。
	SetOutputEncoding	生成されるテキスト出力で予測されるエンコーディングをホストに指示します。

このページのトップへ

解説

ホストはテキストテンプレートファイルを入力として受け取り、テキストファイルを出力として生成します。一般的なホストは、Visual Studio プロジェクト内のテンプレートを変換する TextTemplatingFileGenerator ツールです。異なる種類のテンプレートを扱うために、1 つ以上のディレクティブプロセッサを呼出します。このインターフェイスのメンバーは、ディレクティブプロセッサとテキストテンプレートのコードにアクセス可能です。テキストテンプレートエンジンはこのプロセスを制御し、ホストと 1 つ以上のディレクティブプロセッサと対話します。これらのコンポーネントの詳細については、「コード生成と T4 テキストテンプレート」を参照してください。

ホストがテキストテンプレートのコードからアクセスできるようにするには、テンプレートディレクティブの hostspecific パラメーターを設定します。次に例を示します。

<#@template language="c#" hostspecific="true" #>
<# // This template is specific to the TextTemplatingFileGenerator host,
   // which transforms templates in a Visual Studio project. #>
These are the projects in this solution:
<#=this.Host.ResolveParameterValue("-", "-", "projects") #>

Visual Studio の外部で、またはカスタムツールでテキストテンプレートを使用する場合は、このインターフェイスを実装して、カスタムホストを書き込むことができます。例については、「チュートリアル: カスタムテキストテンプレートホストの作成」を参照してください。

参照

その他の技術情報

チュートリアル: カスタムテキストテンプレートホストの作成

コード生成と T4 テキストテンプレート

ITextTemplatingEngineHost インターフェイス

構文

プロパティ

メソッド

解説

参照

関連項目

その他の技術情報

その他のリソース