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.10.0 (in Microsoft.VisualStudio.TextTemplating.10.0.dll)
Syntax
'Declaration
Public Sub Write ( _
format As String, _
ParamArray args As Object() _
)
public void Write(
string format,
params Object[] args
)
public:
void Write(
String^ format,
... array<Object^>^ args
)
member Write :
format:string *
args:Object[] -> unit
public function Write(
format : String,
... args : Object[]
)
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.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | format is nulla null reference (Nothing in Visual Basic). -or- args is nulla null reference (Nothing in Visual Basic). |
| FormatException | format is invalid. |
| ArgumentOutOfRangeException | Enlarging the value of the underlying StringBuilder would exceed MaxCapacity. |
Remarks
The Write method can be used directly in a text template.
Examples
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.
<#
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
}
#>
<#
Dim message as String = "{0}: This is text to append number {1:F}."
Dim j as Integer = 0
Write(message, 0, 0) 'Using the Write method
WriteLine(Nothing) 'Using the WriteLine method
WriteLine(Nothing) 'Using the WriteLine method
For j = 1 To 3
WriteLine(message, j, j) 'Using the WriteLine method
Next
#>
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.
.NET Framework Security
- 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.
See Also
Reference
Microsoft.VisualStudio.TextTemplating Namespace