StringBuilder.Append Method (String)

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

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

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

Syntax

Public Function Append ( _
    value As String _
) As StringBuilder
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() + Environment.NewLine
' 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 nullNothingnullptra null reference (Nothing in Visual Basic), no changes are made.

The capacity of this instance is adjusted as needed.

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

See Also

Reference

StringBuilder Class

Append Overload

System.Text Namespace

String