Engine-Klasse

Das Textvorlagentransformations-Modul.

Vererbungshierarchie

System.Object
  Microsoft.VisualStudio.TextTemplating.Engine

Namespace:  Microsoft.VisualStudio.TextTemplating
Assembly:  Microsoft.VisualStudio.TextTemplating.10.0 (in Microsoft.VisualStudio.TextTemplating.10.0.dll)

Syntax

'Declaration
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

Der Engine-Typ macht die folgenden Member verfügbar.

Konstruktoren

  Name Beschreibung
Öffentliche Methode Engine Initialisiert eine neue Instanz der Engine-Klasse.

Zum Seitenanfang

Methoden

  Name Beschreibung
Öffentliche Methode Equals Bestimmt, ob das angegebene Object und das aktuelle Object gleich sind. (Von Object geerbt.)
Geschützte Methode Finalize Ermöglicht es einem Objekt, zu versuchen, Ressourcen freizugeben und führt andere Bereinigungsvorgänge aus, bevor es von Garbage Collection freigegeben wird. (Von Object geerbt.)
Öffentliche Methode GetHashCode Fungiert als Hashfunktion für einen besonderen Typ. (Von Object geerbt.)
Öffentliche Methode GetType Ruft den Type der aktuellen Instanz ab. (Von Object geerbt.)
Geschützte Methode MemberwiseClone Erstellt eine flache Kopie des aktuellen Object. (Von Object geerbt.)
Öffentliche Methode PreprocessTemplate Generiert Code aus einer Vorlage, der bei der Kompilierung und Ausführung die Vorlagenausgabe erzeugt.
Öffentliche Methode ProcessTemplate Transformiert den Inhalt einer Textvorlagendatei, um die generierte Textausgabe zu erzeugen.
Öffentliche Methode ToString Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Von Object geerbt.)

Zum Seitenanfang

Felder

  Name Beschreibung
Öffentliches FeldStatischer Member CacheAssembliesOptionString

Zum Seitenanfang

Hinweise

Der Textvorlagen-Transformationsprozess erfordert eine Textvorlagendatei als Eingabe und erzeugt eine neue Textdatei als Ausgabe. Die Textvorlagen-Transformationsmodul-Komponente steuert den Prozess und interagiert mit einem Textvorlagen-Transformationshost und einem oder mehreren Textvorlagendirektivenprozessoren, um den Prozess abzuschließen. Weitere Informationen finden Sie unter Codegenerierung und T4-Textvorlagen.

Tipp

Wenn Sie ein Paket oder eine Erweiterung schreiben, die in Visual Studio ausgeführt wird, verwenden Sie ggf. den Textvorlagendienst, anstatt einen eigenen Host zu schreiben. Weitere Informationen finden Sie unter Aufrufen von Texttransformation in einer VS-Erweiterung.

Beispiele

Im folgenden Beispiel wird das Erstellen einer Instanz des Engine-Elements und Aufrufen des ProcessTemplate-Elements veranschaulicht.

Dieses Codebeispiel ist Teil eines umfangreicheren Beispiels für die ITextTemplatingEngineHost-Schnittstelle.

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)

Threadsicherheit

Alle öffentlichen static (Shared in Visual Basic)-Member dieses Typs sind threadsicher. Bei Instanzmembern ist die Threadsicherheit nicht gewährleistet.

Siehe auch

Referenz

Microsoft.VisualStudio.TextTemplating-Namespace

ITextTemplatingEngineHost

Weitere Ressourcen

Verarbeiten von Textvorlagen mithilfe eines benutzerdefinierten Hosts

Exemplarische Vorgehensweise: Erstellen eines benutzerdefinierten Textvorlagenhosts

Codegenerierung und T4-Textvorlagen