Export (0) Print
Expand All

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

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.

Notes to Callers

In the .NET Framework 4, when you instantiate the StringBuilder object by calling the StringBuilder constructor, both the length and the capacity of the StringBuilder instance can grow beyond the value of its MaxCapacity property. This can occur particularly when you call the Append and AppendFormat methods to append small strings.

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.


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Community Additions

ADD
Show:
© 2014 Microsoft