We recommend using Visual Studio 2017
This documentation is archived and is not being maintained.

Engine Class

The text template transformation engine.


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

public class Engine : IDebugTextTemplatingEngine, ITextTemplatingEngine

The Engine type exposes the following members.

Public methodEngineInitializes a new instance of the Engine class.

Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodPrepareTransformationRunPrepares an IDebugTransformationRun object to run the template.
Public methodPreprocessTemplateGenerates code from a template that, when it is compiled and run, will produce the template output.
Public methodProcessTemplateTransforms the contents of a text template file to produce the generated text output.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Public fieldStatic memberCacheAssembliesOptionStringCacheAssemblies option string.
Public fieldStatic memberTemplateFileParameterName

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 Code Generation and T4 Text Templates.


If you are writing a package or extension that will run within Visual Studio, consider using the text templating service instead of writing your own host. For more information, see Invoking Text Transformation in a VS Extension.

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.