Engine.ProcessTemplate 方法

發行項
10/31/2012

轉換文字範本檔的內容，以產生所產生的文字輸出。

命名空間： 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
要轉換的文字範本檔內容。

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，按一下使用者介面 (UI) 的 [執行自訂工具] 對應於呼叫 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)