StringBuilder.AppendLine Method

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Appends the default line terminator to the end of the current StringBuilder object.

Namespace: System.Text
Assembly: mscorlib (in mscorlib.dll)

Syntax

Public Function AppendLine As StringBuilder
public StringBuilder AppendLine()

Return Value

Type: System.Text..::.StringBuilder
A reference to this instance after the append operation has completed.

Exceptions

Exception Condition
ArgumentOutOfRangeException

Enlarging the value of this instance would exceed its maximum capacity.

Remarks

The default line terminator is the current value of the Environment..::.NewLine property.

The capacity of this instance is adjusted as needed.

Examples

The following code example demonstrates the AppendLine method.

' This example demonstrates the StringBuilder.AppendLine() 
' method.
Imports System.Text

Class Example
   Public Shared Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)
      Dim sb As New StringBuilder()
      Dim line As String = "A line of text."
      Dim number As Integer = 123

      ' Append two lines of text.
      sb.AppendLine("The first line of text.")
      sb.AppendLine(line)

      ' Append a new line, an empty string, and a null cast as a string.
      sb.AppendLine()
      sb.AppendLine("")
      sb.AppendLine(CStr(Nothing))

      ' Append the non-string value, 123, and two new lines.
      sb.Append(number).AppendLine().AppendLine()

      ' Append two lines of text.
      sb.AppendLine(line)
      sb.AppendLine("The last line of text.")

      ' Convert the value of the StringBuilder to a string and display the string.
      outputBlock.Text &= sb.ToString() & vbCrLf
   End Sub 'Main
End Class 'Sample
'
'This example produces the following results:
'
'The first line of text.
'A line of text.
'
'
'
'123
'
'A line of text.
'The last line of text.
// This example demonstrates the StringBuilder.AppendLine() 
// method.

using System;
using System.Text;

class Example
{
   public static void Demo(System.Windows.Controls.TextBlock outputBlock)
   {
      StringBuilder sb = new StringBuilder();
      string line = "A line of text.";
      int number = 123;

      // Append two lines of text.
      sb.AppendLine("The first line of text.");
      sb.AppendLine(line);

      // Append a new line, an empty string, and a null cast as a string.
      sb.AppendLine();
      sb.AppendLine("");
      sb.AppendLine((string)null);

      // Append the non-string value, 123, and two new lines.
      sb.Append(number).AppendLine().AppendLine();

      // Append two lines of text.
      sb.AppendLine(line);
      sb.AppendLine("The last line of text.");

      // Convert the value of the StringBuilder to a string and display the string.
      outputBlock.Text += sb.ToString() + "\n";
   }
}
/*
This example produces the following results:

The first line of text.
A line of text.



123

A line of text.
The last line of text.
*/

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

See Also

Reference

StringBuilder Class

AppendLine Overload

System.Text Namespace

String