Updated: January 2012
Appends a copy of the specified string to this instance.
Assembly: mscorlib (in mscorlib.dll)
Public Function Append ( _ value As String _ ) As StringBuilder
public StringBuilder Append( string value )
public:
StringBuilder^ Append(
String^ value
)
member Append : value:string -> StringBuilder
Parameters
- value
- Type: System.String
The string to append.
Return Value
Type: System.Text.StringBuilderA reference to this instance after the append operation has completed.
| Exception | Condition |
|---|---|
| ArgumentOutOfRangeException |
Enlarging the value of this instance would exceed MaxCapacity. |
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(".") Console.WriteLine(sb.ToString()) ' 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("."); Console.WriteLine(sb.ToString()); // The example displays the following output: // The value of the flag is False.
If value is null, no changes are made.
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.
.NET Framework
Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0.NET Framework Client Profile
Supported in: 4, 3.5 SP1Portable Class Library
Supported in: Portable Class LibraryWindows 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
|
Date |
History |
Reason |
|---|---|---|
|
January 2012 |
Added the Notes to Callers section. |
Content bug fix. |
|
December 2010 |
Expanded the Remarks section and removed the example. |
Customer feedback. |