Export (0) Print
Expand All

TextTransformation.WriteLine Method (String, Object[])

Appends a formatted string, which contains zero or more format specifications, and the default line terminator, to the generated text output. Each format specification is replaced by the string representation of a corresponding object argument.

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

public void WriteLine(
	string format,
	params Object[] args
)

Parameters

format
Type: System.String

A string that contains zero or more format specifications.

args
Type: System.Object[]

An array of objects to format.

ExceptionCondition
ArgumentNullException

format is null.

-or-

args is null.

FormatException

format is invalid.

ArgumentOutOfRangeException

Enlarging the value of the underlying StringBuilder would exceed MaxCapacity.

The WriteLine method can be used directly in a text template.

The following code example demonstrates calling the WriteLine method from a text template. Paste this code into any text template file and run the text template transformation to see the results.

<#
    string message = @"{0}: This is text to append number {1:F}.";

    Write(message, 0, 0);          //Using the Write method
    WriteLine(null);               //Using the WriteLine method
    WriteLine(null);               //Using the WriteLine method
    
    for(int j=1; j<4; j++)
    {
        WriteLine(message, j, j);  //Using the WriteLine method
    }
#>

This example produces the following output:

0: This is text to append number 0.00.

    

1: This is text to append number 1.00.

2: This is text to append number 2.00.

3: This is text to append number 3.00.

Show:
© 2014 Microsoft