Engine Class (Microsoft.VisualStudio.TextTemplating)

Engine Class
This page is specific to:.NET Framework Version:3.5

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

C++

JScript

Copia negli Appunti Stampa

'Utilizzo

Dim instance As Engine

'Dichiarazione

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.

C++

JScript

Copia negli Appunti Stampa

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)

Inheritance Hierarchy

System..::.Object
Microsoft.VisualStudio.TextTemplating..::.Engine

Thread Safety

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

Concepts

About Text Template Hosts

Walkthrough: Creating a Custom Text Template Host

Generating Artifacts By Using Text Templates

Reference

Engine Members

Microsoft.VisualStudio.TextTemplating Namespace

ITextTemplatingEngineHost