Share via

TextTransform

  • Article

Runs a transform on a specified text template file from the command line.

TextTransform.exe is a command-line tool that you can use to transform a text template. When you call TextTransform.exe, you specify the name of a text template file as an argument. TextTransform.exe calls the text transformation engine and processes the text template.

TextTransform.exe is located in the following directory:

<root>\Program Files\Common Files\Microsoft Shared\Text Templating\1.2

For more information, see Command-Line Tools for Text Templates.

TextTransform [<options>] <templateName>

Parameters

Argument

Description

templateName

Identifies the name of the template file that you want to transform. For more information about how to create a new text template, see How to: Create Text Templates.

Option

Description

-out <filename>

The file to which the output of the transform is written.

-r <assembly>

References an assembly for compiling and running the text template.

-u <namespace>

Imports a namespace for use within the template.

-I <includedirectory>

Provides a directory containing text templates included from within the specified text template.

-P <referencepath>

Provides a directory to search for referenced assemblies specified within the text template or for using the -r option.

-dp <processorName>!<className>!<assemblyName|codeBase>

The name, full type name, and assembly of a directive processor that can be used to process custom directives within the text template.

-a [processorName]![directiveName]!<parameterName>!<parameterValue>

Warning

Always type the ‘!’ marks, even if you omit the optional processor and directive names. For example:

-a !!param!value

Specifies a parameter that a directive processor can query for as a name/value pair. The directive processor and identifier are optional. This allows parameters to be specified for any directive processor or any instance of a particular directive processor.

To access the parameter values from a directive processor or text template, use ResolveParameterValue(String, String, String). In a text template, include hostspecific in the template directive and invoke the message on this.Host. For example:

<#@template language="c#" hostspecific="true"#>
[<#= this.Host.ResolveParameterValue("", "", "parameterName") #>]

-h

Provides help.

Remarks

TextTransform.exe is located in the <root>\Program Files\Common Files\Microsoft Shared\Text Templating\1.1 directory of your Domain-Specific Language Tools installation.

Security

For more information, see Security of Text Templates.

See Also

Reference

Command-Line Tools for Text Templates

Other Resources

Generating Artifacts By Using Text Templates

Change History

Date

History

Reason

Explained how to get –a values.

Customer feedback.