TextTransformation::Write Method (String^, array<Object^>^)

 

Appends a formatted string, which contains zero or more format specifications, 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 Write(
	String^ format,
	... array<Object^>^ args
)

Parameters

format
Type: System::String^

A string that contains zero or more format specifications.

args
Type: array<System::Object^>^

An array of objects to format.

Exception Condition
ArgumentNullException

format is null.

-or-

args is null.

FormatException

format is invalid.

ArgumentOutOfRangeException

Enlarging the value of the underlying StringBuilder would exceed MaxCapacity.

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

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

No code example is currently available or this language may not be supported.

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.

Return to top
Show: