Engine.ProcessTemplate, méthode

Article
08/10/2011

Transforme le contenu d'un fichier de modèle de texte en vue de produire la sortie de texte générée.

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

Syntaxe

'Déclaration
Public Function ProcessTemplate ( _
    content As String, _
    host As ITextTemplatingEngineHost _
) As String

public string ProcessTemplate(
    string content,
    ITextTemplatingEngineHost host
)

public:
virtual String^ ProcessTemplate(
    String^ content, 
    ITextTemplatingEngineHost^ host
) sealed

abstract ProcessTemplate : 
        content:string * 
        host:ITextTemplatingEngineHost -> string 
override ProcessTemplate : 
        content:string * 
        host:ITextTemplatingEngineHost -> string

public final function ProcessTemplate(
    content : String, 
    host : ITextTemplatingEngineHost
) : String

Paramètres

content
Type : System.String
Contenu du fichier de modèle de texte à transformer.

host
Type : Microsoft.VisualStudio.TextTemplating.ITextTemplatingEngineHost
ITextTemplatingEngineHost qui hébergera ce moteur.

Valeur de retour

Type : System.String
Sortie de texte générée du fichier de modèle de texte.

Implémentations

ITextTemplatingEngine.ProcessTemplate(String, ITextTemplatingEngineHost)

Exceptions

Exception	Condition
ArgumentNullException	content est nullune référence null (Nothing en Visual Basic). ou host est nullune référence null (Nothing en Visual Basic).

ArgumentNullException

content est nullune référence null (Nothing en Visual Basic).

host est nullune référence null (Nothing en Visual Basic).

Notes

Dans Visual Studio, si un fichier a sa propriété Outil personnalisé définie à TextTemplatingFileGenerator, le clic sur Exécuter un outil personnalisé dans l'interface utilisateur correspond à appeler ProcessTemplate pour transformer le modèle.

Pour plus d'informations, consultez How to: Create Text Templates et Traitement des modèles de texte à l'aide d'un hôte personnalisé.

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é .NET Framework

Confiance totale accordée à l'appelant immédiat. Ce membre ne peut pas être utilisé par du code d'un niveau de confiance partiel. Pour plus d'informations, consultez Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.