StringBuilder.Append Method (String)

Updated: January 2011

Appends a copy of the specified string to the end of this instance.

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

Syntax

'Declaration
<SecuritySafeCriticalAttribute> _
Public Function Append ( _
    value As String _
) As StringBuilder
[SecuritySafeCriticalAttribute]
public StringBuilder Append(
    string value
)

Parameters

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 Append method modifies the existing instance of this class; it does not return a new class instance. Because of this, you can call a method or property on the existing reference and you do not have to assign the return value to a StringBuilder object, as the following example illustrates.

Dim flag As Boolean = false
Dim sb As New System.Text.StringBuilder
sb.Append("The value of the flag is ").Append(flag).Append(".")
outputBlock.Text += sb.ToString() + vbCrLf
' The example displays the following output:
'       The value of the flag is False.
 bool flag = false;
 System.Text.StringBuilder sb = new System.Text.StringBuilder();
 sb.Append("The value of the flag is ").Append(flag).Append(".");
outputBlock.Text += sb.ToString() + Environment.NewLine;
 // The example displays the following output:
 //       The value of the flag is False.

If value is nulla null reference (Nothing in Visual Basic), no changes are made.

The capacity of this instance is adjusted as needed.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Change History

Date

History

Reason

January 2011

Expanded the Remarks section and removed the example.

Customer feedback.