Partager via


TextTransformation, classe

Classe de base abstraite pour toutes les classes de transformation générées.Cette classe fournit également des méthodes utilitaires et des propriétés applicables au code de modèle de texte.

Hiérarchie d'héritage

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

Espace de noms :  Microsoft.VisualStudio.TextTemplating
Assembly :  Microsoft.VisualStudio.TextTemplating.11.0 (dans Microsoft.VisualStudio.TextTemplating.11.0.dll)

Syntaxe

'Déclaration
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

Le type TextTransformation expose les membres suivants.

Constructeurs

  Nom Description
Méthode protégée TextTransformation Initialise une nouvelle instance de la classe TextTransformation.

Début

Propriétés

  Nom Description
Propriété publique CurrentIndent Obtient le texte de retrait actuel, ajouté au début de chaque ligne de la sortie de texte générée.
Propriété publique Errors Infrastructure. Obtient la collection d'erreurs pour le processus de transformation de modèle de texte.
Propriété protégée GenerationEnvironment Obtient ou définit la chaîne utilisée par le processus de transformation de modèle de texte pour assembler la sortie de texte générée.
Propriété publique Session Obtient ou définit la session active.Une session représente une série de transformations exécutées au sein de la même commande utilisateur.L'objet session peut être utilisé pour transmettre des informations au code d'un modèle de texte.

Début

Méthodes

  Nom Description
Méthode publique ClearIndent Remplace le CurrentIndent par une chaîne vide.
Méthode publique Dispose() Libère toutes les ressources utilisées par TextTransformation.
Méthode protégée Dispose(Boolean) Libère les ressources non managées utilisées par TextTransformation et libère éventuellement les ressources managées.
Méthode publique Equals Détermine si l'objet spécifié est identique à l'objet actuel. (Hérité de Object.)
Méthode publique Error Crée une erreur pour consigner des informations à propos des erreurs qui se produisent pendant le processus de transformation de modèle de texte.
Méthode protégée Finalize Autorise Object à tenter de libérer des ressources et d'exécuter d'autres opérations de nettoyage avant qu'il soit récupéré par le garbage collector.Appelé par le garbage collector. (Substitue Object.Finalize().)
Méthode publique GetHashCode Sert de fonction de hachage pour un type particulier. (Hérité de Object.)
Méthode publique GetType Obtient le Type de l'instance actuelle. (Hérité de Object.)
Méthode publique Initialize Infrastructure. Initialise la classe TextTransformation.
Méthode protégée MemberwiseClone Crée une copie superficielle de l'objet Object actuel. (Hérité de Object.)
Méthode publique PopIndent Supprime le dernier texte ajouté à partir de CurrentIndent.
Méthode publique PushIndent Ajoute le texte à CurrentIndent, lequel est placé au début de chaque ligne dans la sortie de texte générée.
Méthode publique ToString Retourne une chaîne qui représente l'objet actuel. (Hérité de Object.)
Méthode publique TransformText En cas de substitution dans une classe dérivée, génère la sortie de texte de la transformation.
Méthode publique Warning Crée un avertissement pour consigner des informations à propos des erreurs qui se produisent pendant le processus de transformation de modèle de texte.
Méthode publique Write(String) Ajoute une copie de la chaîne spécifiée à la sortie de texte générée.
Méthode publique Write(String, array<Object[]) Ajoute, à la sortie de texte générée, une chaîne mise en forme qui contient zéro, une ou plusieurs spécifications de format.Chaque spécification de format est remplacée par la représentation sous forme de chaîne d'un argument objet correspondant.
Méthode publique WriteLine(String) Ajoute, à la sortie de texte générée, une copie de la chaîne spécifiée et la marque de fin de ligne par défaut.
Méthode publique WriteLine(String, array<Object[]) Ajoute, à la sortie de texte générée, une chaîne mise en forme qui contient zéro, une ou plusieurs spécifications de format et la marque de fin de ligne par défaut.Chaque spécification de format est remplacée par la représentation sous forme de chaîne d'un argument objet correspondant.

Début

Notes

Le processus de transformation de modèle de texte comporte deux étapes.Dans la première étape, le moteur de transformation du modèle de texte crée une classe qui est référencée en tant que classe de transformation générée.Dans la deuxième étape, le moteur compile et exécute la classe de transformation générée, pour produire la sortie de texte générée.La classe de transformation générée hérite de TextTransformation.

Toute classe spécifiée dans une directive inherits dans un modèle de texte doit hériter de TextTransformation.TransformText est le seul membre abstract de cette classe.

Sécurité des threads

Tous les membres static (Shared en Visual Basic) publics de ce type sont thread-safe. Il n'est pas garanti que les membres d'instance soient thread-safe.

Voir aussi

Référence

Microsoft.VisualStudio.TextTemplating, espace de noms

Autres ressources

Génération de code et modèles de texte T4