Engine.ProcessTemplate - метод

Статья
08/11/2011

Преобразует содержимое текстового файла шаблона, создавая выходной текст.

Пространство имен: 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 имеет значение nullпустая ссылка (Nothing в Visual Basic). – или – Параметр host имеет значение nullпустая ссылка (Nothing в Visual Basic).

ArgumentNullException

Параметр content имеет значение nullпустая ссылка (Nothing в Visual Basic).

– или –

Параметр host имеет значение nullпустая ссылка (Nothing в Visual Basic).

Заметки

В 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

Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Дополнительные сведения см. в разделе Использование библиотек из не вполне надежного кода.