Engine Class (Microsoft.VisualStudio.TextTemplating)

Cambia visualizzazione

Comprimi tutto

Domain-Specific Language Tools Reference

Engine Class

The text template transformation engine.

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

Syntax

Visual Basic (Declaration)

Public Class Engine _
    Implements ITextTemplatingEngine

Visual Basic (Usage)

Dim instance As Engine

public class Engine : ITextTemplatingEngine

Visual C++

public ref class Engine : ITextTemplatingEngine

JScript

public class Engine implements ITextTemplatingEngine

Remarks

The text template transformation process takes a text template file as the input, and produces a new text file as the output. The text template transformation engine component controls the process, and interacts with a text template transformation host and one or more text template directive processors to complete the process. For more information, see Generating Artifacts By Using Text Templates.

Examples

The following example demonstrates how to create an instance of the Engine, and calling ProcessTemplate to transform a text template.

This code example is part of a larger example provided for the ITextTemplatingEngineHost interface.

Engine engine = new Engine();

//read the text template
string input = File.ReadAllText(templateFileName);

//transform the text template
string output = engine.ProcessTemplate(input, host);

Visual Basic

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)