次の方法で共有

Engine.ProcessTemplate メソッド

  • [アーティクル]

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

名前空間:  Microsoft.VisualStudio.TextTemplating
アセンブリ:  Microsoft.VisualStudio.TextTemplating.11.0 (Microsoft.VisualStudio.TextTemplating.11.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
    変換するテキスト テンプレート ファイルの内容。

戻り値

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

実装

ITextTemplatingEngine.ProcessTemplate(String, ITextTemplatingEngineHost)

例外

例外 条件
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)

.NET Framework セキュリティ

  • 直前の呼び出し元に対する完全な信頼。このメンバーは、部分的に信頼されているコードから使用することはできません。詳細については、「部分信頼コードからのライブラリの使用」を参照してください。

参照

関連項目

Engine クラス

Microsoft.VisualStudio.TextTemplating 名前空間

ITextTemplatingEngineHost

ArgumentNullException

ProcessTemplate

その他の技術情報

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