Engine.ProcessTemplate-Methode

Artikel
07/20/2011

Transformiert den Inhalt einer Textvorlagendatei, um die generierte Textausgabe zu erzeugen.

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

Syntax

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

Parameter

content
Typ: System.String
Der Inhalt einer Textvorlagendatei, der transformiert werden soll.

host
Typ: Microsoft.VisualStudio.TextTemplating.ITextTemplatingEngineHost
Der ITextTemplatingEngineHost, der dieses Modul hostet.

Rückgabewert

Typ: System.String
Der von der Textvorlagendatei ausgegebene generierte Text.

Implementiert

ITextTemplatingEngine.ProcessTemplate(String, ITextTemplatingEngineHost)

Ausnahmen

Ausnahme	Bedingung
ArgumentNullException	content hat den Wert nullNULL-Verweis (Nothing in Visual Basic). – oder – host hat den Wert nullNULL-Verweis (Nothing in Visual Basic).

ArgumentNullException

content hat den Wert nullNULL-Verweis (Nothing in Visual Basic).

– oder –

host hat den Wert nullNULL-Verweis (Nothing in Visual Basic).

Hinweise

Wenn in einer Datei in Visual Studio die Custom Tool-Eigenschaft auf TextTemplatingFileGenerator festgelegt ist, entspricht das Klicken auf Benutzerdefiniertes Tool ausführen in der Benutzeroberfläche dem Aufrufen von ProcessTemplate für die Transformation der Vorlage.

Weitere Informationen finden Sie unter How to: Create Text Templates und Verarbeiten von Textvorlagen mithilfe eines benutzerdefinierten Hosts.

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)

.NET Framework-Sicherheit

Volle Vertrauenswürdigkeit für den unmittelbaren Aufrufer. Dieser Member kann von nur teilweise vertrauenswürdigem Code nicht verwendet werden. Weitere Informationen finden Sie unter Verwenden von Bibliotheken aus teilweise vertrauenswürdigem Code.