Engine - класс

Статья
08/11/2011

Модуль преобразования текстового шаблона.

Иерархия наследования

System.Object
Microsoft.VisualStudio.TextTemplating.Engine

Пространство имен: Microsoft.VisualStudio.TextTemplating
Сборка: Microsoft.VisualStudio.TextTemplating.10.0 (в Microsoft.VisualStudio.TextTemplating.10.0.dll)

Синтаксис

'Декларация
Public Class Engine _
    Implements ITextTemplatingEngine

public class Engine : ITextTemplatingEngine

public ref class Engine : ITextTemplatingEngine

type Engine =  
    class
        interface ITextTemplatingEngine
    end

public class Engine implements ITextTemplatingEngine

Тип Engine предоставляет следующие члены.

Конструкторы

	Имя	Описание
	Engine	Инициализирует новый экземпляр класса Engine.

В начало страницы

Методы

	Имя	Описание
	Equals	Определяет, равен ли заданный объект Object текущему объекту Object. (Унаследовано от Object.)
	Finalize	Позволяет объекту попытаться освободить ресурсы и выполнить другие операции очистки, перед тем как объект будет утилизирован в процессе сборки мусора. (Унаследовано от Object.)
	GetHashCode	Играет роль хэш-функции для определенного типа. (Унаследовано от Object.)
	GetType	Возвращает объект Type для текущего экземпляра. (Унаследовано от Object.)
	MemberwiseClone	Создает неполную копию текущего объекта Object. (Унаследовано от Object.)
	PreprocessTemplate	Создание кода из шаблона, в результате компиляции и выполнения которого получаются выходные данные шаблона.
	ProcessTemplate	Преобразует содержимое текстового файла шаблона, создавая выходной текст.
	ToString	Возвращение строки, представляющей текущий объект. (Унаследовано от Object.)

В начало страницы

Поля

	Имя	Описание
	CacheAssembliesOptionString

В начало страницы

Заметки

Процесс преобразования текстового шаблона принимает в качестве входных данных файл текстового шаблона и создает новый текстовый файл. Для завершения процесса, компонент ядра преобразования текстового шаблона контролирует процесс и взаимодействует с узлом преобразования текстового шаблона, и с одним или несколькими процессорами директивы шаблона текста. Дополнительные сведения см. в разделе Создание кода и текстовые шаблоны T4.

Совет

При создании пакета или расширения, который будет выполняться в 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)

Потокобезопасность

Любые открытые члены этого типа, объявленные как static (Shared в Visual Basic), являются потокобезопасными. Потокобезопасность членов экземпляров не гарантируется.