ITextTemplatingEngineHost - интерфейс

Статья
08/11/2011

Интерфейс для узла, преобразующего текстовые шаблоны. Этот объект доступен обработчикам директив, доступ к нему также может осуществляться из текстовых шаблонов.

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

Синтаксис

'Декларация
<CLSCompliantAttribute(True)> _
Public Interface ITextTemplatingEngineHost

[CLSCompliantAttribute(true)]
public interface ITextTemplatingEngineHost

[CLSCompliantAttribute(true)]
public interface class ITextTemplatingEngineHost

[<CLSCompliantAttribute(true)>]
type ITextTemplatingEngineHost =  interface end

public interface ITextTemplatingEngineHost

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

Свойства

	Имя	Описание
	StandardAssemblyReferences	Получает список ссылок на сборки.
	StandardImports	Получает список пространств имен.
	TemplateFile	Получает путь и имя обрабатываемого файла текстового шаблона.

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

Методы

	Имя	Описание
	GetHostOption	Вызывается процессором для запроса значения указанного параметра.Возвращайте значение null, если не знаете.
	LoadIncludeText	Получает текст, соответствующий запросу на включение частичного файла текстового шаблона.
	LogErrors	Получает коллекцию ошибок и предупреждений из модуля преобразования.
	ProvideTemplatingAppDomain	Предоставляет домен приложения для выполнения создаваемого класса преобразования.
	ResolveAssemblyReference	Позволяет узлу предоставлять дополнительные сведения о расположении сборки.
	ResolveDirectiveProcessor	Возвращает тип процессора директив с указанным понятным именем.
	ResolveParameterValue	Получает имя параметра процессора директив с указанным значением, если этот параметр не указан в тексте шаблона.
	ResolvePath	Позволяет основному приложению предоставить полный путь, получив имя файла или относительный путь.
	SetFileExtension	Предоставляет узлу расширение имени файла, ожидаемое для создаваемого выходного текста.
	SetOutputEncoding	Предоставляет узлу кодировку, ожидаемую для создаваемого выходного текста.

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

Заметки

Основное приложение принимает файл текстового шаблона в качестве входных данных и генерирует текстовый файл в качестве выходных данных. Типичным основным приложением является средство TextTemplatingFileGenerator, преобразующее шаблоны в проекте Visual Studio. Он вызывает один или несколько процессоров директив для обработки разных типов шаблонов. Члены этого интерфейса доступны для процессоров директив, а также для кода шаблона текста. Обработчик текстовых шаблонов контролирует этот процесс и взаимодействует с основным приложением и одним или несколькими процессорами директив. Для получения дополнительных сведений об этих компонентах см Создание кода и текстовые шаблоны T4.

Чтобы сделать узел доступным коду текстового шаблона, задайте значение для параметра hostspecific директивы шаблона. Примеры.

<#@template language="c#" hostspecific="true" #>
<# // This template is specific to the TextTemplatingFileGenerator host,
   // which transforms templates in a Visual Studio project. #>
These are the projects in this solution:
<#=this.Host.ResolveParameterValue("-", "-", "projects") #>

Если требуется использовать текстовые шаблоны вне Visual Studio или с помощью пользовательских средств, можно написать пользовательское основное приложение, реализуя этот интерфейс. Пример см. в разделе Пошаговое руководство. Создание пользовательского хост-класса для текстовых шаблонов.

Совет

При создании пакета или расширения, который будет выполняться в Visual Studio, можно воспользоваться службой текстовых шаблонов, а не создавать собственный узел.Дополнительные сведения см. в разделе Вызов преобразования текста в расширении VS.

См. также

Ссылки

Microsoft.VisualStudio.TextTemplating - пространство имен

Другие ресурсы

Пошаговое руководство. Создание пользовательского хост-класса для текстовых шаблонов

Создание кода и текстовые шаблоны T4

Журнал изменений

Дата	Журнал	Причина
Июнь 2010	Уточнены некоторые описания методов.	Улучшение информации.

Июнь 2010

Уточнены некоторые описания методов.

Улучшение информации.

Поделиться через