Engine, classe

Article
08/10/2011

Moteur de transformation du modèle de texte.

Hiérarchie d'héritage

System.Object
Microsoft.VisualStudio.TextTemplating.Engine

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

Syntaxe

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

Le type Engine expose les membres suivants.

Constructeurs

	Nom	Description
	Engine	Initialise une nouvelle instance de la classe Engine.

Début

Méthodes

	Nom	Description
	Equals	Détermine si l'Object spécifié est égal à l'Object en cours. (Hérité de Object.)
	Finalize	Autorise un objet à tenter de libérer des ressources et d'exécuter d'autres opérations de nettoyage avant qu'il ne soit récupéré par l'opération garbage collection. (Hérité de Object.)
	GetHashCode	Sert de fonction de hachage pour un type particulier. (Hérité de Object.)
	GetType	Obtient le Type de l'instance actuelle. (Hérité de Object.)
	MemberwiseClone	Crée une copie superficielle de l'objet Object actif. (Hérité de Object.)
	PreprocessTemplate	Génère du code à partir d'un modèle qui, lorsqu'il est compilé et exécuté, produit la sortie de modèle.
	ProcessTemplate	Transforme le contenu d'un fichier de modèle de texte en vue de produire la sortie de texte générée.
	ToString	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object.)

Début

Champs

	Nom	Description
	CacheAssembliesOptionString

Début

Notes

Le processus de transformation de modèle de texte prend un fichier de modèle de texte comme entrée et produit un nouveau fichier texte comme sortie. Le composant du moteur de transformation du modèle de texte contrôle le processus et interagit avec un hôte de transformation du modèle de texte et un ou plusieurs processeurs de directive de modèle de texte pour effectuer le processus. Pour plus d'informations, consultez Génération de code et modèles de texte T4.

Conseil

Si vous écrivez un package ou une extension qui s'exécutera dans Visual Studio, envisagez d'utiliser le service de création de modèles de texte, plutôt que d'écrire dans votre propre hôte. Pour plus d'informations, consultez Appel d'une transformation de texte dans une extension VS.

Exemples

L'exemple suivant montre comment créer une instance du Engine, et appeler ProcessTemplate pour transformer un modèle de texte.

Cet exemple de code fait partie d'un exemple plus complet fourni pour l'interface 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)

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.