Engine クラス

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

継承階層

System.Object
  Microsoft.VisualStudio.TextTemplating.Engine

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

構文

'宣言
Public Class Engine _
    Implements IDebugTextTemplatingEngine, ITextTemplatingEngine

public class Engine : IDebugTextTemplatingEngine, ITextTemplatingEngine

public ref class Engine : IDebugTextTemplatingEngine, ITextTemplatingEngine

type Engine =  
    class
        interface IDebugTextTemplatingEngine
        interface ITextTemplatingEngine
    end

public class Engine implements IDebugTextTemplatingEngine, ITextTemplatingEngine

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

コンストラクター

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

このページのトップへ

メソッド

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

このページのトップへ

フィールド

	名前	説明
	CacheAssembliesOptionString	CacheAssemblies のオプション文字列。
	TemplateFileParameterName

このページのトップへ

解説

テキスト テンプレート変換プロセスは、入力としてテキスト テンプレート ファイルを受け取り、新しいテキスト ファイルを出力として生成します。テキスト テンプレート変換エンジンの内在コントロールは、テキスト テンプレート変換ホスト によってプロセスと対話しながら、および一つまたは複数のプロセスを完了するには、テンプレート ディレクティブ プロセッサを表示します。詳細については、「コード生成と 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)

スレッド セーフ

この型のすべてのパブリック static (Visual Basic では Shared) メンバーは、スレッド セーフです。インスタンス メンバーの場合は、スレッド セーフであるとは限りません。

参照

関連項目

Microsoft.VisualStudio.TextTemplating 名前空間

ITextTemplatingEngineHost

その他の技術情報

カスタム ホストを使用したテキスト テンプレートの処理

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

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