TextTransformation.WriteLine Method (String)

Appends a copy of the specified string and the default line terminator to the generated text output.

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

Syntax

'Declaration
Public Sub WriteLine ( _
    textToAppend As String _
)
public void WriteLine(
    string textToAppend
)
public:
void WriteLine(
    String^ textToAppend
)
member WriteLine : 
        textToAppend:string -> unit
public function WriteLine(
    textToAppend : String
)

Parameters

  • textToAppend
    Type: String

    The string to write.

Exceptions

Exception Condition
ArgumentOutOfRangeException

Enlarging the value of the underlying StringBuilder would exceed MaxCapacity.

Remarks

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

Examples

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 text = @"This is text to append to my output file.";

    Write(text);          //Using the Write method
    WriteLine(null);      //Using the WriteLine method  
    WriteLine(null);      //Using the WriteLine method  
    
    for(int i=1; i<4; i++)
    {
        WriteLine(text);  //Using the WriteLine method  
    }
#>
<#  
    Dim text as String = "This is text to append to my output file."
    Dim i as Integer = 0

    Write(text)            'Using the Write method
    WriteLine(Nothing)     'Using the WriteLine method  
    WriteLine(Nothing)     'Using the WriteLine method  
    
    For i = 1 To 3

        WriteLine(text)    'Using the WriteLine method  
    Next
#>

This example produces the following output:

This is text to append to my output file.

    

This is text to append to my output file.

This is text to append to my output file.

This is text to append to my output file.

.NET Framework Security

See Also

Reference

TextTransformation Class

WriteLine Overload

Microsoft.VisualStudio.TextTemplating Namespace

GenerationEnvironment

StringBuilder

MaxCapacity

ArgumentOutOfRangeException

Other Resources

How to: Append to the Generated Text