StringBuilder.AppendLine Method

Reference

Definition

Namespace:: System.Text

Assemblies:: mscorlib.dll, System.Runtime.dll

Assemblies:: netstandard.dll, System.Runtime.dll

Assembly:: System.Runtime.dll

Assembly:: mscorlib.dll

Assembly:: netstandard.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Appends the default line terminator, or a copy of a specified string and the default line terminator, to the end of this instance.

Overloads

AppendLine()	Appends the default line terminator to the end of the current StringBuilder object.
AppendLine(String)	Appends a copy of the specified string followed by the default line terminator to the end of the current StringBuilder object.
AppendLine(StringBuilder+AppendInterpolatedStringHandler)	Appends the specified interpolated string followed by the default line terminator to the end of the current StringBuilder object.
AppendLine(IFormatProvider, StringBuilder+AppendInterpolatedStringHandler)	Appends the specified interpolated string using the specified format, followed by the default line terminator, to the end of the current StringBuilder object.

AppendLine()

Source:: StringBuilder.cs

Source:: StringBuilder.cs

Source:: StringBuilder.cs

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

public:
 System::Text::StringBuilder ^ AppendLine();

public System.Text.StringBuilder AppendLine();

[System.Runtime.InteropServices.ComVisible(false)]
public System.Text.StringBuilder AppendLine();

member this.AppendLine : unit -> System.Text.StringBuilder

[<System.Runtime.InteropServices.ComVisible(false)>]
member this.AppendLine : unit -> System.Text.StringBuilder

Public Function AppendLine () As StringBuilder

Returns

StringBuilder

A reference to this instance after the append operation has completed.

Attributes: ComVisibleAttribute

Exceptions

ArgumentOutOfRangeException

Enlarging the value of this instance would exceed MaxCapacity.

Examples

The following example demonstrates the AppendLine method.

// This example demonstrates the StringBuilder.AppendLine()
// method.

using namespace System;
using namespace System::Text;

int main()
{
    StringBuilder^ sb = gcnew StringBuilder;
    String^ line = L"A line of text.";
    int number = 123;

    // Append two lines of text.
    sb->AppendLine( L"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( L"" );
    sb->AppendLine( L"" );

    // 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( L"The last line of text." );

    // Convert the value of the StringBuilder to a string and display the string.
    Console::WriteLine( sb );

    return 0;
}

/*
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 Sample
{
    public static void Main()
    {
    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.
    Console.WriteLine(sb.ToString());
    }
}
/*
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.

open System.Text

let sb = StringBuilder()
let line = "A line of text."
let number = 123

// Append two lines of text.
sb.AppendLine "The first line of text." |> ignore
sb.AppendLine line |> ignore

// Append a new line, an empty string, and a null cast as a string.
sb.AppendLine() |> ignore
sb.AppendLine "" |> ignore
sb.AppendLine Unchecked.defaultof<string> |> ignore

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

// Append two lines of text.
sb.AppendLine line |> ignore
sb.AppendLine "The last line of text." |> ignore

// Convert the value of the StringBuilder to a string and display the string.
printfn $"{sb}"

// 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.
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
End Class
'
'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.

Remarks

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 .NET Core and in the .NET Framework 4.0 and later versions, when you instantiate the StringBuilder object by calling the StringBuilder(Int32, Int32) 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(String) and AppendFormat(String, Object) methods to append small strings.

Applies to

.NET 10 and other versions

Product	Versions
.NET	Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework	2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP	10.0

AppendLine(String)

Source:: StringBuilder.cs

Source:: StringBuilder.cs

Source:: StringBuilder.cs

Appends a copy of the specified string followed by the default line terminator to the end of the current StringBuilder object.

public:
 System::Text::StringBuilder ^ AppendLine(System::String ^ value);

public System.Text.StringBuilder AppendLine(string value);

public System.Text.StringBuilder AppendLine(string? value);

[System.Runtime.InteropServices.ComVisible(false)]
public System.Text.StringBuilder AppendLine(string value);

member this.AppendLine : string -> System.Text.StringBuilder

[<System.Runtime.InteropServices.ComVisible(false)>]
member this.AppendLine : string -> System.Text.StringBuilder

Public Function AppendLine (value As String) As StringBuilder

Parameters

value: String

The string to append.

Returns

StringBuilder

A reference to this instance after the append operation has completed.

Attributes: ComVisibleAttribute

Exceptions

ArgumentOutOfRangeException

Enlarging the value of this instance would exceed MaxCapacity.

Remarks

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

Applies to

.NET 10 and other versions

Product	Versions
.NET	Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework	2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP	10.0

AppendLine(StringBuilder+AppendInterpolatedStringHandler)

Source:: StringBuilder.cs

Source:: StringBuilder.cs

Source:: StringBuilder.cs

Appends the specified interpolated string followed by the default line terminator to the end of the current StringBuilder object.

public:
 System::Text::StringBuilder ^ AppendLine(System::Text::StringBuilder::AppendInterpolatedStringHandler % handler);

public System.Text.StringBuilder AppendLine(ref System.Text.StringBuilder.AppendInterpolatedStringHandler handler);

member this.AppendLine : AppendInterpolatedStringHandler -> System.Text.StringBuilder

Public Function AppendLine (ByRef handler As StringBuilder.AppendInterpolatedStringHandler) As StringBuilder

Parameters

handler: StringBuilder.AppendInterpolatedStringHandler

The interpolated string to append.

Returns

StringBuilder

A reference to this instance after the append operation has completed.

Applies to

.NET 10 and other versions

Product	Versions
.NET	6, 7, 8, 9, 10

AppendLine(IFormatProvider, StringBuilder+AppendInterpolatedStringHandler)

Source:: StringBuilder.cs

Source:: StringBuilder.cs

Source:: StringBuilder.cs

Appends the specified interpolated string using the specified format, followed by the default line terminator, to the end of the current StringBuilder object.

public:
 System::Text::StringBuilder ^ AppendLine(IFormatProvider ^ provider, System::Text::StringBuilder::AppendInterpolatedStringHandler % handler);

public System.Text.StringBuilder AppendLine(IFormatProvider? provider, ref System.Text.StringBuilder.AppendInterpolatedStringHandler handler);

member this.AppendLine : IFormatProvider * AppendInterpolatedStringHandler -> System.Text.StringBuilder

Public Function AppendLine (provider As IFormatProvider, ByRef handler As StringBuilder.AppendInterpolatedStringHandler) As StringBuilder

Parameters

provider: IFormatProvider

An object that supplies culture-specific formatting information.

handler: StringBuilder.AppendInterpolatedStringHandler

The interpolated string to append.

Returns

StringBuilder

A reference to this instance after the append operation has completed.

Applies to

.NET 10 and other versions

Product	Versions
.NET	6, 7, 8, 9, 10

Share via

StringBuilder.AppendLine Method

Definition

Overloads

AppendLine()

Returns

Exceptions

Examples

Remarks

Notes to Callers

See also

Applies to

AppendLine(String)

Parameters

Returns

Exceptions

Remarks

Notes to Callers

See also

Applies to

AppendLine(StringBuilder+AppendInterpolatedStringHandler)

Parameters

Returns

Applies to

AppendLine(IFormatProvider, StringBuilder+AppendInterpolatedStringHandler)

Parameters

Returns

Applies to

Additional resources