通过

使用自定义宿主处理文本模板

  • 项目

更新：2010 年 10 月

文本模板转换过程将文本模板文件作为输入，并生成一个文本文件作为输出。 从 Visual Studio 扩展或安装有 Visual Studio 的计算机上运行的独立应用程序，可以调用文本转换引擎。 不过，您必须提供文本模板化宿主。 该类将模板连接到环境，查找资源（如程序集和包含文件），并处理输出和错误消息。

提示

如果要编写将在 Visual Studio 内运行的包或扩展，请考虑使用文本模板化服务而不是编写您自己的主机。 有关更多信息，请参见在 VS 扩展中调用文本转换。

提示

不建议在服务器应用程序中使用文本模板转换。 除非是在单个线程中，否则不建议使用文本模板转换。 这是因为文本模板化引擎可以重用单个 AppDomain，以便转换、编译和执行模板。 转换的代码未被设计为线程安全的。 该引擎旨在按顺序处理文件，因为在设计时它们位于 Visual Studio 项目中。

对于运行时应用程序，请考虑使用预处理过的文本模板：请参见使用预处理 T4 文本模板生成运行时文本。

如果应用程序使用一组在编译时固定的模板，使用预处理文本模板会更为简单。 如果应用程序将在未安装 Visual Studio 的计算机上运行，也可以使用该方法。 有关更多信息，请参见使用预处理 T4 文本模板生成运行时文本。

在应用程序中执行文本模板

若要执行文本模板，可以调用 Microsoft.VisualStudio.TextTemplating.Engine 的 ProcessTemplate 方法。

using Microsoft.VisualStudio.TextTemplating;
...
Engine engine = new Engine();
string output = engine.ProcessTemplate(templateString, host);

应用程序必须找到并提供模板，并且必须处理输出。

在 host 参数中，必须提供实现 ITextTemplatingEngineHost 的类。 这是由引擎回调的。

宿主必须能记录错误、解析对程序集和包含文件的引用、提供可在其中执行模板的应用程序域并为每条指令调用相应的处理器。

Microsoft.VisualStudio.TextTemplating.Engine 在 Microsoft.VisualStudio.TextTemplating.10.0.dll 中定义，ITextTemplatingEngineHost 在 Microsoft.VisualStudio.TextTemplating.Interfaces.10.0.dll 中定义。

本节内容

参考

ITextTemplatingEngineHost

相关章节

修订记录

日期

修订记录

原因

2010 年 10 月

有关线程安全的详细说明

客户反馈