Engine.ProcessTemplate メソッド

2011-08-09

テキストテンプレートファイルの内容を変換して、生成されたテキスト出力を生成します。

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

構文

'宣言
Public Function ProcessTemplate ( _
    content As String, _
    host As ITextTemplatingEngineHost _
) As String

public string ProcessTemplate(
    string content,
    ITextTemplatingEngineHost host
)

public:
virtual String^ ProcessTemplate(
    String^ content, 
    ITextTemplatingEngineHost^ host
) sealed

abstract ProcessTemplate : 
        content:string * 
        host:ITextTemplatingEngineHost -> string 
override ProcessTemplate : 
        content:string * 
        host:ITextTemplatingEngineHost -> string

public final function ProcessTemplate(
    content : String, 
    host : ITextTemplatingEngineHost
) : String

パラメーター

content
型: System.String
変換するテキストテンプレートファイルの内容。

host
型: Microsoft.VisualStudio.TextTemplating.ITextTemplatingEngineHost
このエンジンをホストする ITextTemplatingEngineHost。

戻り値

型: System.String
テキストテンプレートファイルの、生成されたテキスト出力。

実装

ITextTemplatingEngine.ProcessTemplate(String, ITextTemplatingEngineHost)

例外

例外	条件
ArgumentNullException	content は nullnull 参照 (Visual Basic では Nothing) なので、または host は nullnull 参照 (Visual Basic では Nothing) なので、

ArgumentNullException

content は nullnull 参照 (Visual Basic では Nothing) なので、

または

host は nullnull 参照 (Visual Basic では Nothing) なので、

解説

Visual Studio では、ファイルに TextTemplatingFileGenerator に設定された [カスタムツール] プロパティがある場合、ユーザーインターフェイスの [カスタムツールの実行] をクリックすることは、ProcessTemplate を呼び出してテンプレートを変換することに対応します。

詳細については、「How to: Create Text Templates」および「カスタムホストを使用したテキストテンプレートの処理」を参照してください。

ヒント

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)