This documentation is archived and is not being maintained.

StringBuilder.AppendLine Method

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

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

'Declaration
<ComVisibleAttribute(False)> _
Public Function AppendLine As StringBuilder
'Usage
Dim instance As StringBuilder 
Dim returnValue As StringBuilder 

returnValue = instance.AppendLine()

Return Value

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

ExceptionCondition
ArgumentOutOfRangeException

Enlarging the value of this instance would exceed MaxCapacity.

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

The capacity of this instance is adjusted as needed.

The following example demonstrates the AppendLine method.

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

Class Sample
   Public Shared Sub Main()
      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.
      Console.WriteLine(sb.ToString())
   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.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0

.NET Compact Framework

Supported in: 3.5

XNA Framework

Supported in: 3.0, 2.0, 1.0
Show: