Freigeben über


TextTransformation-Klasse

Die abstrakte Basisklasse für generierte Transformationsklassen. Diese Klasse stellt auch Dienstprogrammmethoden und -eigenschaften bereit, die in Textvorlagencode verwendet werden können.

Vererbungshierarchie

System.Object
  Microsoft.VisualStudio.TextTemplating.TextTransformation
    Microsoft.VisualStudio.TextTemplating.VSHost.ModelingTextTransformation

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

Syntax

'Declaration
Public MustInherit Class TextTransformation _
    Implements IDisposable
public abstract class TextTransformation : IDisposable
public ref class TextTransformation abstract : IDisposable
[<AbstractClass>]
type TextTransformation =  
    class
        interface IDisposable
    end
public abstract class TextTransformation implements IDisposable

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

Konstruktoren

  Name Beschreibung
Geschützte Methode TextTransformation Initialisiert eine neue Instanz der TextTransformation-Klasse.

Zum Seitenanfang

Eigenschaften

  Name Beschreibung
Öffentliche Eigenschaft CurrentIndent Ruft den aktuellen Einzugstext ab, der jeder Zeile der generierten Textausgabe vorangestellt wird.
Öffentliche Eigenschaft Errors Infrastruktur. Ruft die Fehlerauflistung für den Textvorlagen-Transformationsprozess ab.
Geschützte Eigenschaft GenerationEnvironment Ruft die Zeichenfolge ab, mit der der Textvorlagen-Transformationsprozess die generierte Textausgabe assembliert, oder legt diese Zeichenfolge fest.
Öffentliche Eigenschaft Session Ruft die aktuelle Sitzung ab oder legt diese fest.Eine Sitzung stellt eine Reihe von Transformationen dar, die im Rahmen desselben Benutzerbefehls ausgeführt werden.Mit dem Sitzungsobjekt können Informationen in den Code einer Textvorlage übermittelt werden.

Zum Seitenanfang

Methoden

  Name Beschreibung
Öffentliche Methode ClearIndent Setzt den CurrentIndent auf eine leere Zeichenfolge zurück.
Öffentliche Methode Dispose() Gibt sämtliche von der TextTransformation verwendeten Ressourcen frei.
Geschützte Methode Dispose(Boolean) Gibt die vom TextTransformation verwendeten nicht verwalteten Ressourcen und optional auch die verwalteten Ressourcen frei.
Öffentliche Methode Equals Bestimmt, ob das angegebene Object und das aktuelle Object gleich sind. (Von Object geerbt.)
Öffentliche Methode Error Erstellt eine neue Fehlermeldung, in der Informationen zu Fehlern während des Textvorlagen-Transformationsprozesses gespeichert werden.
Geschützte Methode Finalize Ermöglicht einem Object das Freigeben von Ressourcen sowie das Ausführen weiterer Bereinigungsvorgänge, bevor es vom Garbage Collector wieder zugänglich gemacht wird.Wird vom Garbage Collector aufgerufen. (Überschreibt Object.Finalize().)
Ö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.)
Öffentliche Methode Initialize Infrastruktur. Initialisiert die TextTransformation-Klasse.
Geschützte Methode MemberwiseClone Erstellt eine flache Kopie des aktuellen Object. (Von Object geerbt.)
Öffentliche Methode PopIndent Entfernt den zuletzt hinzugefügten Text aus CurrentIndent.
Öffentliche Methode PushIndent Fügt CurrentIndent Text hinzu, der jeder Zeile der generierten Textausgabe vorangestellt wird.
Öffentliche Methode ToString Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Von Object geerbt.)
Öffentliche Methode TransformText Generiert beim Überschreiben in einer abgeleiteten Klasse die Textausgabe der Transformation.
Öffentliche Methode Warning Erstellt eine neue Warnmeldung, in der Informationen zu Fehlern während des Textvorlagen-Transformationsprozesses gespeichert werden.
Öffentliche Methode Write(String) Fügt eine Kopie der angegebenen Zeichenfolge an die generierte Textausgabe an.
Öffentliche Methode Write(String, array<Object[]) Fügt eine formatierte Zeichenfolge mit 0 (null) oder mehr Formatangaben an die generierte Textausgabe an.Jede Formatangabe wird durch die Zeichenfolgendarstellung eines entsprechenden Objektarguments ersetzt.
Öffentliche Methode WriteLine(String) Fügt eine Kopie der angegebenen Zeichenfolge und des Standardzeilenabschlusszeichens an die generierte Textausgabe an.
Öffentliche Methode WriteLine(String, array<Object[]) Fügt eine formatierte Zeichenfolge mit 0 (null) oder mehr Formatangaben sowie das Standardzeilenabschlusszeichen an die generierte Textausgabe an.Jede Formatangabe wird durch die Zeichenfolgendarstellung eines entsprechenden Objektarguments ersetzt.

Zum Seitenanfang

Hinweise

Der Textvorlagen-Transformationsprozess umfasst zwei Schritte. Im ersten Schritt erstellt das Textvorlagen-Transformationsmodul eine Klasse, die als generierte Transformationsklasse bezeichnet wird. Im zweiten Schritt kompiliert das Modul die generierte Transformationsklasse und kompiliert sie, um die Textausgabe zu generieren. Die generierte Transformationsklasse erbt von TextTransformation.

Jede in einer inherits-Direktive in einer Textvorlage angegebene Klasse muss von TextTransformation erben. TransformText ist der einzige abstract-Member dieser Klasse.

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

Weitere Ressourcen

Codegenerierung und T4-Textvorlagen