This documentation is archived and is not being maintained.

Engine Class

The text template transformation engine.

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

public class Engine : ITextTemplatingEngine

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.

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);


Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.