Engine (Clase)

Motor de transformación de plantillas de texto.

Jerarquía de herencia

System.Object
  Microsoft.VisualStudio.TextTemplating.Engine

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

Sintaxis

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

El tipo Engine expone los siguientes miembros.

Constructores

  Nombre Descripción
Método público Engine Inicializa una nueva instancia de la clase Engine.

Arriba

Métodos

  Nombre Descripción
Método público Equals Determina si el objeto Object especificado es igual al objeto Object actual. (Se hereda de Object).
Método protegido Finalize Permite que un objeto intente liberar recursos y realizar otras operaciones de limpieza antes de ser reclamado por la recolección de elementos no utilizados. (Se hereda de Object).
Método público GetHashCode Actúa como función hash para un tipo concreto. (Se hereda de Object).
Método público GetType Obtiene el objeto Type de la instancia actual. (Se hereda de Object).
Método protegido MemberwiseClone Crea una copia superficial del objeto Object actual. (Se hereda de Object).
Método público PreprocessTemplate Genera código a partir de una plantilla que, cuando se compile y ejecute, generará el resultado de la plantilla.
Método público ProcessTemplate Transforma el contenido de un archivo de plantilla del texto para producir el resultado de texto generado.
Método público ToString Devuelve una cadena que representa el objeto actual. (Se hereda de Object).

Arriba

Campos

  Nombre Descripción
Campo públicoMiembro estático CacheAssembliesOptionString

Arriba

Comentarios

El proceso de transformación de plantilla de texto toma un archivo de plantilla del texto como la entrada y genera un nuevo archivo de texto como la salida. El componente de motor de transformación de plantilla de texto controla el proceso e interactúa con un host de transformación de plantilla de texto y uno o más procesadores de directivas de plantilla de texto para completar el proceso. Para obtener más información, vea Generación de código y plantillas de texto T4.

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.

Ejemplos

En el ejemplo siguiente se muestra cómo se crea una instancia de Engine y se llama a ProcessTemplate para transformar una plantilla de texto.

Este ejemplo de código forma parte de un ejemplo más extenso relativo a la interfaz 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)

Seguridad para subprocesos

Todos los miembros static (Shared en Visual Basic) públicos de este tipo son seguros para la ejecución de subprocesos. No se garantiza que los miembros de instancias sean seguros para la ejecución de subprocesos.

Vea también

Referencia

Microsoft.VisualStudio.TextTemplating (Espacio de nombres)

ITextTemplatingEngineHost

Otros recursos

Procesar las plantillas de texto mediante un host personalizado

Tutorial: Crear un host de plantillas de texto personalizadas

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