TextTransformation.TransformText Method (Microsoft.VisualStudio.TextTemplating)

TransformText Method

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

Domain-Specific Language Tools Reference

TextTransformation..::.TransformText Method

Updated: November 2007

When overridden in a derived class, generates the text output of the transformation.

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

Syntax

Visual Basic (Declaration)

Public MustOverride Function TransformText As String

Visual Basic (Usage)

Dim instance As TextTransformation
Dim returnValue As String

returnValue = instance.TransformText()

public abstract string TransformText()

Visual C++

public:
virtual String^ TransformText() abstract

JScript

public abstract function TransformText() : String

Return Value

Type: System..::.String

A string representing the generated text output of the text template transformation process.

Remarks

The text template transformation process has two steps. In the first step, the text template transformation engine creates a class that is named the generated transformation class. In the second step, the engine compiles and executes the generated transformation class, to produce the generated text output. The engine calls TransformText on the compiled generated transformation class to execute the text template and generate the text output.

Permissions

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Reference

TextTransformation Class

TextTransformation Members

Microsoft.VisualStudio.TextTemplating Namespace

Other Resources

Generating Artifacts By Using Text Templates