Engine.ProcessTemplate 方法

项目
10/25/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，单击在用户界面中 *** 运行自定义工具 *** 对应于调用 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)