Compartir a través de


ITextTemplatingEngineHost (Interfaz)

Interfaz para el host que transforma plantillas de texto. Está disponible para los procesadores de directivas y también pueden tener acceso a ella las plantillas de texto.

Espacio de nombres:  Microsoft.VisualStudio.TextTemplating
Ensamblado:  Microsoft.VisualStudio.TextTemplating.Interfaces.10.0 (en Microsoft.VisualStudio.TextTemplating.Interfaces.10.0.dll)

Sintaxis

'Declaración
<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

El tipo ITextTemplatingEngineHost expone los siguientes miembros.

Propiedades

  Nombre Descripción
Propiedad pública StandardAssemblyReferences Obtiene una lista de referencias de ensamblado.
Propiedad pública StandardImports Obtiene una lista de espacios de nombres.
Propiedad pública TemplateFile Obtiene la ruta de acceso y el nombre de archivo de la plantilla de texto que se está procesando.

Arriba

Métodos

  Nombre Descripción
Método público GetHostOption Lo llama el motor para solicitar el valor de una opción especificada.Devuelve Null si no lo sabe.
Método público LoadIncludeText Adquiere el texto que corresponde a una solicitud para incluir un archivo de plantilla de texto parcial.
Método público LogErrors Recibe una colección de errores y advertencias del motor de transformación.
Método público ProvideTemplatingAppDomain Proporciona un dominio de aplicación para ejecutar la clase de transformación generada.
Método público ResolveAssemblyReference Permite a un host proporcionar información adicional sobre la ubicación de un ensamblado.
Método público ResolveDirectiveProcessor Devuelve el tipo de un procesador de directivas, dado su nombre descriptivo.
Método público ResolveParameterValue Resuelve el valor de un parámetro para un procesador de directivas si el parámetro no se especifica en el texto de la plantilla.
Método público ResolvePath Permite que un host proporcione una ruta de acceso completa, dado un nombre de archivo o una ruta de acceso relativa.
Método público SetFileExtension Indica al host la extensión de nombre de archivo que se espera para la salida de texto generada.
Método público SetOutputEncoding Indica al host la codificación que se espera para la salida de texto generada.

Arriba

Comentarios

Este host toma un archivo de plantilla de texto como la entrada y genera un archivo de texto como la salida. La herramienta TextTemplatingFileGenerator es un host típico que transforma las plantillas en un proyecto de Visual Studio. Llama a uno o varios procesadores de directivas para tratar con distintos tipos de plantilla. Los miembros de esta interfaz son accesibles para los procesadores de directivas y el código de la plantilla de texto. El motor de plantillas de texto controla este proceso e interactúa con un host y uno o más procesadores de directivas. Para obtener más información sobre estos componentes, vea Generación de código y plantillas de texto T4.

Para que el host sea accesible al código de una plantilla de texto, establezca el parámetro hostspecific de la directiva de plantilla. Por ejemplo:

<#@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") #>

Si desea utilizar plantillas de texto fuera de Visual Studio o con herramientas personalizadas, puede escribir un host personalizado, implementando esta interfaz. Para obtener un ejemplo, vea Tutorial: Crear un host de plantillas de texto personalizadas.

SugerenciaSugerencia

Si está escribiendo una extensión o paquete que se ejecutará con Visual Studio, considere la posibilidad de utilizar el servicio de plantillas de texto, en lugar de escribir su propio host. Para obtener más información, vea Invocar la transformación de texto en una extensión de VS.

Vea también

Referencia

Microsoft.VisualStudio.TextTemplating (Espacio de nombres)

Otros recursos

Tutorial: Crear un host de plantillas de texto personalizadas

Generación de código y plantillas de texto T4

Historial de cambios

Fecha

Historial

Motivo

Junio de 2010

Se clarificaron algunas descripciones del método.

Mejora de la información.