Engine クラス

2011-08-09

テキストテンプレート変換エンジン。

継承階層

System.Object
Microsoft.VisualStudio.TextTemplating.Engine

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

構文

'宣言
Public Class Engine _
    Implements ITextTemplatingEngine

public class Engine : ITextTemplatingEngine

public ref class Engine : ITextTemplatingEngine

type Engine =  
    class
        interface ITextTemplatingEngine
    end

public class Engine implements ITextTemplatingEngine

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

コンストラクター

	名前	説明
	Engine	Engine クラスの新しいインスタンスを初期化します。

このページのトップへ

メソッド

	名前	説明
	Equals	指定した Object が、現在の Object と等しいかどうかを判断します。 (Object から継承されます。)
	Finalize	オブジェクトがガベージコレクションにより収集される前に、そのオブジェクトがリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)
	PreprocessTemplate	テンプレートからコードを生成します。そのコードをコンパイルして実行すると、テンプレート出力が生成されます。
	ProcessTemplate	テキストテンプレートファイルの内容を変換して、生成されたテキスト出力を生成します。
	ToString	現在のオブジェクトを表す文字列を返します。 (Object から継承されます。)

このページのトップへ

フィールド

	名前	説明
	CacheAssembliesOptionString

このページのトップへ

解説

テキストテンプレートの変換プロセスは、テキストテンプレートファイルを入力として受け取り、新しいテキストファイルを出力として生成します。テキストテンプレート変換エンジンコンポーネントは、プロセスを制御し、テキストテンプレート変換ホストと 1 つまたは複数のテキストテンプレートディレクティブプロセッサと対話して、プロセスを完了します。詳細については、「コード生成と T4 テキストテンプレート」を参照してください。

ヒント

Visual Studio 内で実行されるパッケージまたは拡張機能を作成する場合は、独自のホストを作成するのではなく、テキストテンプレートサービスを使用することを検討します。詳細については、「VS 拡張機能内でのテキスト変換の呼び出し」を参照してください。

例

次の例は、Engine のインスタンスを作成する方法、および ProcessTemplate を呼び出してテキストテンプレートを変換する方法を示しています。

このコード例は ITextTemplatingEngineHost インターフェイスのトピックで取り上げているコード例の一部分です。

Engine engine = new Engine();

//read the text template
string input = File.ReadAllText(templateFileName);

//transform the text template
string output = engine.ProcessTemplate(input, host);

Dim engine As Engine = New Engine()

'read the text template
Dim input As String = File.ReadAllText(templateFileName)

'transform the text template
Dim output As String = engine.ProcessTemplate(input, host)