StringBuilder.AppendLine Method (String) (System.Text)

Switch View :

ScriptFree

.NET Framework Class Library

StringBuilder.AppendLine Method (String)

Updated: January 2012

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

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

Syntax

Visual Basic

<ComVisibleAttribute(False)> _
Public Function AppendLine ( _
	value As String _
) As StringBuilder

[ComVisibleAttribute(false)]
public StringBuilder AppendLine(
	string value
)

Visual C++

[ComVisibleAttribute(false)]
public:
StringBuilder^ AppendLine(
	String^ value
)

[<ComVisibleAttribute(false)>]
member AppendLine : 
        value:string -> StringBuilder

Parameters

value: Type: System.String
The string to append.

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 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

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.

Version Information

.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

Platforms

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.

Reference

StringBuilder Class

AppendLine Overload

System.Text Namespace

String

Change History

Date	History	Reason
January 2012	Added the Notes to Callers section.	Content bug fix.

Date

History

Reason

January 2012

Added the Notes to Callers section.

Content bug fix.