StringBuilder.Append Method

Definition

Appends the string representation of a specified object to this instance.

Overloads

Append(StringBuilder)

Appends the string representation of a specified string builder to this instance.

Append(UInt16)

Appends the string representation of a specified 16-bit unsigned integer to this instance.

Append(UInt32)

Appends the string representation of a specified 32-bit unsigned integer to this instance.

Append(UInt64)

Appends the string representation of a specified 64-bit unsigned integer to this instance.

Append(Char, Int32)

Appends a specified number of copies of the string representation of a Unicode character to this instance.

Append(Char[], Int32, Int32)

Appends the string representation of a specified subarray of Unicode characters to this instance.

Append(IFormatProvider, StringBuilder+AppendInterpolatedStringHandler)

Appends the specified interpolated string to this instance using the specified format.

Append(String)

Appends a copy of the specified string to this instance.

Append(String, Int32, Int32)

Appends a copy of a specified substring to this instance.

Append(StringBuilder, Int32, Int32)

Appends a copy of a substring within a specified string builder to this instance.

Append(Char*, Int32)

Appends an array of Unicode characters starting at a specified address to this instance.

Append(Single)

Appends the string representation of a specified single-precision floating-point number to this instance.

Append(StringBuilder+AppendInterpolatedStringHandler)

Appends the specified interpolated string to this instance.

Append(ReadOnlySpan<Char>)

Appends the string representation of a specified read-only character span to this instance.

Append(SByte)

Appends the string representation of a specified 8-bit signed integer to this instance.

Append(Boolean)

Appends the string representation of a specified Boolean value to this instance.

Append(Byte)

Appends the string representation of a specified 8-bit unsigned integer to this instance.

Append(Char)

Appends the string representation of a specified Char object to this instance.

Append(Char[])

Appends the string representation of the Unicode characters in a specified array to this instance.

Append(Double)

Appends the string representation of a specified double-precision floating-point number to this instance.

Append(Decimal)

Appends the string representation of a specified decimal number to this instance.

Append(Int32)

Appends the string representation of a specified 32-bit signed integer to this instance.

Append(Int64)

Appends the string representation of a specified 64-bit signed integer to this instance.

Append(Object)

Appends the string representation of a specified object to this instance.

Append(ReadOnlyMemory<Char>)

Appends the string representation of a specified read-only character memory region to this instance.

Append(Int16)

Appends the string representation of a specified 16-bit signed integer to this instance.

Append(StringBuilder)

Appends the string representation of a specified string builder to this instance.

public:
 System::Text::StringBuilder ^ Append(System::Text::StringBuilder ^ value);
public System.Text.StringBuilder Append (System.Text.StringBuilder? value);
public System.Text.StringBuilder Append (System.Text.StringBuilder value);
member this.Append : System.Text.StringBuilder -> System.Text.StringBuilder
Public Function Append (value As StringBuilder) As StringBuilder

Parameters

value
StringBuilder

The string builder to append.

Returns

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

Applies to

Append(UInt16)

Important

This API is not CLS-compliant.

Appends the string representation of a specified 16-bit unsigned integer to this instance.

public:
 System::Text::StringBuilder ^ Append(System::UInt16 value);
[System.CLSCompliant(false)]
public System.Text.StringBuilder Append (ushort value);
[<System.CLSCompliant(false)>]
member this.Append : uint16 -> System.Text.StringBuilder
Public Function Append (value As UShort) As StringBuilder

Parameters

value
UInt16

The value to append.

Returns

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

Attributes

Exceptions

Enlarging the value of this instance would exceed MaxCapacity.

Remarks

The Append(UInt16) 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.

System.Text.StringBuilder sb = new 
            System.Text.StringBuilder("The range of a 16-bit unsigned integer: ");
sb.Append(UInt16.MinValue).Append(" to ").Append(UInt16.MaxValue);
Console.WriteLine(sb);
// The example displays the following output:
//       The range of a 16-bit unsigned integer: 0 to 65535
let sb = StringBuilder "The range of a 16-bit unsigned integer: "
sb.Append(UInt16.MinValue).Append(" to ").Append UInt16.MaxValue |> ignore
printfn $"{sb}"
// The example displays the following output:
//       The range of a 16-bit unsigned integer: 0 to 65535
Dim sb As New System.Text.StringBuilder("The range of a 16-bit unsigned integer: ")
sb.Append(UInt16.MinValue).Append(" to ").Append(UInt16.MaxValue)
Console.WriteLine(sb)
' The example displays the following output:
'       The range of a 16-bit unsigned integer: 0 to 65535

The Append(UInt16) method calls the UInt16.ToString(IFormatProvider) method to get the string representation of value. To control the formatting of value, call the AppendFormat method.

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.

See also

Applies to

Append(UInt32)

Important

This API is not CLS-compliant.

Appends the string representation of a specified 32-bit unsigned integer to this instance.

public:
 System::Text::StringBuilder ^ Append(System::UInt32 value);
[System.CLSCompliant(false)]
public System.Text.StringBuilder Append (uint value);
[<System.CLSCompliant(false)>]
member this.Append : uint32 -> System.Text.StringBuilder
Public Function Append (value As UInteger) As StringBuilder

Parameters

value
UInt32

The value to append.

Returns

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

Attributes

Exceptions

Enlarging the value of this instance would exceed MaxCapacity.

Remarks

The Append(UInt32) 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.

System.Text.StringBuilder sb = new 
            System.Text.StringBuilder("The range of a 32-bit unsigned integer: ");
sb.Append(UInt32.MinValue).Append(" to ").Append(UInt32.MaxValue);
Console.WriteLine(sb);
// The example displays the following output:
//       The range of a 32-bit unsigned integer: 0 to 4294967295
let sb = StringBuilder "The range of a 32-bit unsigned integer: "
sb.Append(UInt32.MinValue).Append(" to ").Append UInt32.MaxValue |> ignore
printfn $"{sb}"
// The example displays the following output:
//       The range of a 32-bit unsigned integer: 0 to 4294967295
Dim sb As New System.Text.StringBuilder("The range of a 32-bit unsigned integer: ")
sb.Append(UInt32.MinValue).Append(" to ").Append(UInt32.MaxValue)
Console.WriteLine(sb)
' The example displays the following output:
'       The range of a 32-bit unsigned integer: 0 to 4294967295

The Append(UInt32) calls the UInt32.ToString method to get the string representation of value for the current culture. To control the formatting of value, call the AppendFormat method.

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.

See also

Applies to

Append(UInt64)

Important

This API is not CLS-compliant.

Appends the string representation of a specified 64-bit unsigned integer to this instance.

public:
 System::Text::StringBuilder ^ Append(System::UInt64 value);
[System.CLSCompliant(false)]
public System.Text.StringBuilder Append (ulong value);
[<System.CLSCompliant(false)>]
member this.Append : uint64 -> System.Text.StringBuilder
Public Function Append (value As ULong) As StringBuilder

Parameters

value
UInt64

The value to append.

Returns

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

Attributes

Exceptions

Enlarging the value of this instance would exceed MaxCapacity.

Remarks

The Append(UInt64) 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.

System.Text.StringBuilder sb = new 
            System.Text.StringBuilder("The range of a 64-bit unsigned integer: ");
sb.Append(UInt64.MinValue).Append(" to ").Append(UInt64.MaxValue);
Console.WriteLine(sb);
// The example displays the following output:
//       The range of a 64-bit unsigned integer: 0 to 18446744073709551615
let sb = StringBuilder "The range of a 64-bit unsigned integer: "
sb.Append(UInt64.MinValue).Append(" to ").Append UInt64.MaxValue |> ignore
printfn $"{sb}"
// The example displays the following output:
//       The range of a 64-bit unsigned integer: 0 to 18446744073709551615
Dim sb As New System.Text.StringBuilder("The range of a 64-bit unsigned integer: ")
sb.Append(UInt64.MinValue).Append(" to ").Append(UInt64.MaxValue)
Console.WriteLine(sb)
' The example displays the following output:
'       The range of a 64-bit unsigned integer: 0 to 18446744073709551615

The Append(UInt64) method calls the UInt64.ToString(IFormatProvider) method to get the string representation of value for the current culture. To control the formatting of value, call the AppendFormat method.

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.

See also

Applies to

Append(Char, Int32)

Appends a specified number of copies of the string representation of a Unicode character to this instance.

public:
 System::Text::StringBuilder ^ Append(char value, int repeatCount);
public System.Text.StringBuilder Append (char value, int repeatCount);
member this.Append : char * int -> System.Text.StringBuilder
Public Function Append (value As Char, repeatCount As Integer) As StringBuilder

Parameters

value
Char

The character to append.

repeatCount
Int32

The number of times to append value.

Returns

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

Exceptions

repeatCount is less than zero.

-or-

Enlarging the value of this instance would exceed MaxCapacity.

Out of memory.

Remarks

The Append(Char, Int32) 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.

decimal value = 1346.19m;
System.Text.StringBuilder sb = new System.Text.StringBuilder();
sb.Append('*', 5).AppendFormat("{0:C2}", value).Append('*', 5);
Console.WriteLine(sb);
// The example displays the following output:
//       *****$1,346.19*****
let value = 1346.19m
let sb = StringBuilder()
sb.Append('*', 5).AppendFormat("{0:C2}", value).Append('*', 5) |> ignore
printfn $"{sb}"
// The example displays the following output:
//       *****$1,346.19*****
Dim value As Decimal = 1346.19d
Dim sb As New System.Text.StringBuilder()
sb.Append("*"c, 5).AppendFormat("{0:C2}", value).Append("*"c, 5)
Console.WriteLine(sb)
' The example displays the following output:
'       *****$1,346.19*****

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.

See also

Applies to

Append(Char[], Int32, Int32)

Appends the string representation of a specified subarray of Unicode characters to this instance.

public:
 System::Text::StringBuilder ^ Append(cli::array <char> ^ value, int startIndex, int charCount);
public System.Text.StringBuilder Append (char[] value, int startIndex, int charCount);
public System.Text.StringBuilder Append (char[]? value, int startIndex, int charCount);
member this.Append : char[] * int * int -> System.Text.StringBuilder
Public Function Append (value As Char(), startIndex As Integer, charCount As Integer) As StringBuilder

Parameters

value
Char[]

A character array.

startIndex
Int32

The starting position in value.

charCount
Int32

The number of characters to append.

Returns

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

Exceptions

value is null, and startIndex and charCount are not zero.

charCount is less than zero.

-or-

startIndex is less than zero.

-or-

startIndex + charCount is greater than the length of value.

-or-

Enlarging the value of this instance would exceed MaxCapacity.

Remarks

This method appends the specified range of characters in value to the current instance. If value is null and startIndex and count are both zero, no changes are made.

The Append(Char[], Int32, Int32) 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.

char[] chars = { 'a', 'b', 'c', 'd', 'e'};
System.Text.StringBuilder sb = new System.Text.StringBuilder();
int startPosition = Array.IndexOf(chars, 'a');
int endPosition = Array.IndexOf(chars, 'c');
if (startPosition >= 0 && endPosition >= 0) {
   sb.Append("The array from positions ").Append(startPosition).
             Append(" to ").Append(endPosition).Append(" contains ").
             Append(chars, startPosition, endPosition + 1).Append(".");
   Console.WriteLine(sb);
}             
// The example displays the following output:
//       The array from positions 0 to 2 contains abc.
let chars = [| 'a'; 'b'; 'c'; 'd'; 'e' |]
let sb = StringBuilder()
let startPosition = Array.IndexOf(chars, 'a')
let endPosition = Array.IndexOf(chars, 'c')

if startPosition >= 0 && endPosition >= 0 then
    sb
        .Append("The array from positions ")
        .Append(startPosition)
        .Append(" to ")
        .Append(endPosition)
        .Append(" contains ")
        .Append(chars, startPosition, endPosition + 1)
        .Append "."
    |> ignore

    printfn $"{sb}"
// The example displays the following output:
//       The array from positions 0 to 2 contains abc.
Dim chars() As Char = { "a"c, "b"c, "c"c, "d"c, "e"c}
Dim sb As New System.Text.StringBuilder()
Dim startPosition As Integer = Array.IndexOf(chars, "a"c)
Dim endPosition As Integer = Array.IndexOf(chars, "c"c)
If startPosition >= 0 AndAlso endPosition >= 0 Then
   sb.Append("The array from positions ").Append(startPosition).
             Append(" to ").Append(endPosition).Append(" contains ").
             Append(chars, startPosition, endPosition + 1).Append(".")
   Console.WriteLine(sb)
End If             
' The example displays the following output:
'       The array from positions 0 to 2 contains abc.

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.

See also

Applies to

Append(IFormatProvider, StringBuilder+AppendInterpolatedStringHandler)

Appends the specified interpolated string to this instance using the specified format.

public:
 System::Text::StringBuilder ^ Append(IFormatProvider ^ provider, System::Text::StringBuilder::AppendInterpolatedStringHandler % handler);
public System.Text.StringBuilder Append (IFormatProvider? provider, ref System.Text.StringBuilder.AppendInterpolatedStringHandler handler);
member this.Append : IFormatProvider * AppendInterpolatedStringHandler -> System.Text.StringBuilder
Public Function Append (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

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

Applies to

Append(String)

Appends a copy of the specified string to this instance.

public:
 System::Text::StringBuilder ^ Append(System::String ^ value);
public System.Text.StringBuilder Append (string value);
public System.Text.StringBuilder Append (string? value);
member this.Append : string -> System.Text.StringBuilder
Public Function Append (value As String) As StringBuilder

Parameters

value
String

The string to append.

Returns

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

Exceptions

Enlarging the value of this instance would exceed MaxCapacity.

Remarks

The Append(String) 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.

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.
let flag = false
let sb = StringBuilder()
sb.Append("The value of the flag is ").Append(flag).Append "." |> ignore
printfn $"{sb}"
// The example displays the following output:
//       The value of the flag is False.
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.

If value is null, no changes are made.

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.

See also

Applies to

Append(String, Int32, Int32)

Appends a copy of a specified substring to this instance.

public:
 System::Text::StringBuilder ^ Append(System::String ^ value, int startIndex, int count);
public System.Text.StringBuilder Append (string value, int startIndex, int count);
public System.Text.StringBuilder Append (string? value, int startIndex, int count);
member this.Append : string * int * int -> System.Text.StringBuilder
Public Function Append (value As String, startIndex As Integer, count As Integer) As StringBuilder

Parameters

value
String

The string that contains the substring to append.

startIndex
Int32

The starting position of the substring within value.

count
Int32

The number of characters in value to append.

Returns

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

Exceptions

value is null, and startIndex and count are not zero.

count less than zero.

-or-

startIndex less than zero.

-or-

startIndex + count is greater than the length of value.

-or-

Enlarging the value of this instance would exceed MaxCapacity.

Remarks

This method appends the specified range of characters in value to the current instance. If value is null and startIndex and count are both zero, no changes are made.

The Append(String, Int32, Int32) 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.

string str = "First;George Washington;1789;1797";
int index = 0;
System.Text.StringBuilder sb = new System.Text.StringBuilder();
int length = str.IndexOf(';', index);      
sb.Append(str, index, length).Append(" President of the United States: ");
index += length + 1;
length = str.IndexOf(';', index) - index;
sb.Append(str, index, length).Append(", from ");
index += length + 1;
length = str.IndexOf(';', index) - index;
sb.Append(str, index, length).Append(" to ");
index += length + 1;
sb.Append(str, index, str.Length - index);
Console.WriteLine(sb);
// The example displays the following output:
//    First President of the United States: George Washington, from 1789 to 1797
let str = "First;George Washington;1789;1797"
let mutable index = 0
let sb = StringBuilder()
let length = str.IndexOf(';', index)

sb.Append(str, index, length).Append " President of the United States: "
|> ignore

index <- index + length + 1
let length = str.IndexOf(';', index) - index
sb.Append(str, index, length).Append ", from " |> ignore
index <- index + length + 1
let length = str.IndexOf(';', index) - index
sb.Append(str, index, length).Append " to " |> ignore
index <- index + length + 1
sb.Append(str, index, str.Length - index) |> ignore
printfn $"{sb}"
// The example displays the following output:
//    First President of the United States: George Washington, from 1789 to 1797
Dim str As String = "First;George Washington;1789;1797"
Dim index As Integer = 0
Dim sb As New System.Text.StringBuilder()
Dim length As Integer = str.IndexOf(";"c, index)      
sb.Append(str, index, length).Append(" President of the United States: ")
index += length + 1
length = str.IndexOf(";"c, index) - index
sb.Append(str, index, length).Append(", from ")
index += length + 1
length = str.IndexOf(";"c, index) - index
sb.Append(str, index, length).Append(" to ")
index += length + 1
sb.Append(str, index, str.Length - index)
Console.WriteLine(sb)
' The example displays the following output:
'    First President of the United States: George Washington, from 1789 to 1797

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.

See also

Applies to

Append(StringBuilder, Int32, Int32)

Appends a copy of a substring within a specified string builder to this instance.

public:
 System::Text::StringBuilder ^ Append(System::Text::StringBuilder ^ value, int startIndex, int count);
public System.Text.StringBuilder Append (System.Text.StringBuilder? value, int startIndex, int count);
public System.Text.StringBuilder Append (System.Text.StringBuilder value, int startIndex, int count);
member this.Append : System.Text.StringBuilder * int * int -> System.Text.StringBuilder
Public Function Append (value As StringBuilder, startIndex As Integer, count As Integer) As StringBuilder

Parameters

value
StringBuilder

The string builder that contains the substring to append.

startIndex
Int32

The starting position of the substring within value.

count
Int32

The number of characters in value to append.

Returns

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

Applies to

Append(Char*, Int32)

Important

This API is not CLS-compliant.

CLS-compliant alternative
System.Text.StringBuilder.Append(Char[], Int32, Int32)

Appends an array of Unicode characters starting at a specified address to this instance.

public:
 System::Text::StringBuilder ^ Append(char* value, int valueCount);
[System.CLSCompliant(false)]
[System.Security.SecurityCritical]
public System.Text.StringBuilder Append (char* value, int valueCount);
[System.CLSCompliant(false)]
public System.Text.StringBuilder Append (char* value, int valueCount);
[<System.CLSCompliant(false)>]
[<System.Security.SecurityCritical>]
member this.Append : nativeptr<char> * int -> System.Text.StringBuilder
[<System.CLSCompliant(false)>]
member this.Append : nativeptr<char> * int -> System.Text.StringBuilder

Parameters

value
Char*

A pointer to an array of characters.

valueCount
Int32

The number of characters in the array.

Returns

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

Attributes

Exceptions

valueCount is less than zero.

-or-

Enlarging the value of this instance would exceed MaxCapacity.

value is a null pointer.

Remarks

This method appends valueCount characters starting at address value to the current instance.

The Append(Char*, Int32) 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.

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

Append(Single)

Appends the string representation of a specified single-precision floating-point number to this instance.

public:
 System::Text::StringBuilder ^ Append(float value);
public System.Text.StringBuilder Append (float value);
member this.Append : single -> System.Text.StringBuilder
Public Function Append (value As Single) As StringBuilder

Parameters

value
Single

The value to append.

Returns

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

Exceptions

Enlarging the value of this instance would exceed MaxCapacity.

Remarks

The Append(Single) 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.

float value = 1034769.47f;
System.Text.StringBuilder sb = new System.Text.StringBuilder();
sb.Append('*', 5).Append(value).Append('*', 5);
Console.WriteLine(sb);
// The example displays the following output:
//       *****1034769.47*****
let value = 1034769.47f
let sb = StringBuilder()
sb.Append('*', 5).Append(value).Append('*', 5) |> ignore
printfn $"{sb}"
// The example displays the following output:
//       *****1034769.47*****
Dim value As Single = 1034769.47
Dim sb As New System.Text.StringBuilder()
sb.Append("*"c, 5).Append(value).Append("*"c, 5)
Console.WriteLine(sb)
' The example displays the following output:
'       *****1034769.47*****

The Append(Single) method calls the Single.ToString method to get the string representation of value for the current culture. To control the formatting of value, call the AppendFormat method.

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.

See also

Applies to

Append(StringBuilder+AppendInterpolatedStringHandler)

Appends the specified interpolated string to this instance.

public:
 System::Text::StringBuilder ^ Append(System::Text::StringBuilder::AppendInterpolatedStringHandler % handler);
public System.Text.StringBuilder Append (ref System.Text.StringBuilder.AppendInterpolatedStringHandler handler);
member this.Append : AppendInterpolatedStringHandler -> System.Text.StringBuilder
Public Function Append (ByRef handler As StringBuilder.AppendInterpolatedStringHandler) As StringBuilder

Parameters

handler
StringBuilder.AppendInterpolatedStringHandler

The interpolated string to append.

Returns

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

Applies to

Append(ReadOnlySpan<Char>)

Appends the string representation of a specified read-only character span to this instance.

public:
 System::Text::StringBuilder ^ Append(ReadOnlySpan<char> value);
public System.Text.StringBuilder Append (ReadOnlySpan<char> value);
member this.Append : ReadOnlySpan<char> -> System.Text.StringBuilder
Public Function Append (value As ReadOnlySpan(Of Char)) As StringBuilder

Parameters

value
ReadOnlySpan<Char>

The read-only character span to append.

Returns

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

Applies to

Append(SByte)

Important

This API is not CLS-compliant.

Appends the string representation of a specified 8-bit signed integer to this instance.

public:
 System::Text::StringBuilder ^ Append(System::SByte value);
[System.CLSCompliant(false)]
public System.Text.StringBuilder Append (sbyte value);
[<System.CLSCompliant(false)>]
member this.Append : sbyte -> System.Text.StringBuilder
Public Function Append (value As SByte) As StringBuilder

Parameters

value
SByte

The value to append.

Returns

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

Attributes

Exceptions

Enlarging the value of this instance would exceed MaxCapacity.

Remarks

The Append(SByte) 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.

System.Text.StringBuilder sb = new 
            System.Text.StringBuilder("The range of an 8-bit signed integer: ");
sb.Append(SByte.MinValue).Append(" to ").Append(SByte.MaxValue);
Console.WriteLine(sb);
// The example displays the following output:
//       The range of an 8-bit unsigned integer: -128 to 127
let sb = StringBuilder "The range of an 8-bit signed integer: "
sb.Append(SByte.MinValue).Append(" to ").Append SByte.MaxValue |> ignore
printfn $"{sb}"
// The example displays the following output:
//       The range of an 8-bit unsigned integer: -128 to 127
Dim sb As New System.Text.StringBuilder("The range of an 8-bit signed integer: ")
sb.Append(SByte.MinValue).Append(" to ").Append(SByte.MaxValue)
Console.WriteLine(sb)
' The example displays the following output:
'       The range of an 8-bit unsigned integer: -128 to 127

The Append(SByte) method calls the SByte.ToString(IFormatProvider) method to get the string representation of value for the current culture. To control the formatting of value, call the AppendFormat method.

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.

See also

Applies to

Append(Boolean)

Appends the string representation of a specified Boolean value to this instance.

public:
 System::Text::StringBuilder ^ Append(bool value);
public System.Text.StringBuilder Append (bool value);
member this.Append : bool -> System.Text.StringBuilder
Public Function Append (value As Boolean) As StringBuilder

Parameters

value
Boolean

The Boolean value to append.

Returns

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

Exceptions

Enlarging the value of this instance would exceed MaxCapacity.

Remarks

The Append(Boolean) 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.

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.
let flag = false
let sb = StringBuilder()
sb.Append("The value of the flag is ").Append(flag).Append "." |> ignore
printfn $"{sb}"
// The example displays the following output:
//       The value of the flag is False.
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.

The Append(Boolean) method calls the Boolean.ToString() method to get the string representation of value. 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.

See also

Applies to

Append(Byte)

Appends the string representation of a specified 8-bit unsigned integer to this instance.

public:
 System::Text::StringBuilder ^ Append(System::Byte value);
public System.Text.StringBuilder Append (byte value);
member this.Append : byte -> System.Text.StringBuilder
Public Function Append (value As Byte) As StringBuilder

Parameters

value
Byte

The value to append.

Returns

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

Exceptions

Enlarging the value of this instance would exceed MaxCapacity.

Remarks

The Append(Byte) 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.

Byte[] bytes = { 16, 132, 27, 253 };
System.Text.StringBuilder sb = new System.Text.StringBuilder();
foreach (var value in bytes)
   sb.Append(value).Append(" ");         

Console.WriteLine("The byte array: {0}", sb.ToString());
// The example displays the following output:
//         The byte array: 16 132 27 253
let bytes = [| 16uy; 132uy; 27uy; 253uy |]
let sb = StringBuilder()

for value in bytes do
    sb.Append(value).Append " " |> ignore

printfn $"The byte array: {sb}"
// The example displays the following output:
//         The byte array: 16 132 27 253
Dim bytes() As Byte = { 16, 132, 27, 253 }
Dim sb As New System.Text.StringBuilder()
For Each value In bytes
   sb.Append(value).Append(" ")         
Next
Console.WriteLine("The byte array: {0}", sb.ToString())
' The example displays the following output:
'         The byte array: 16 132 27 253

The Append(Byte) method calls the ToString(IFormatProvider) method to get the string representation of value for the current culture. To control the formatting of value, call the AppendFormat method.

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.

See also

Applies to

Append(Char)

Appends the string representation of a specified Char object to this instance.

public:
 System::Text::StringBuilder ^ Append(char value);
public System.Text.StringBuilder Append (char value);
member this.Append : char -> System.Text.StringBuilder
Public Function Append (value As Char) As StringBuilder

Parameters

value
Char

The UTF-16-encoded code unit to append.

Returns

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

Exceptions

Enlarging the value of this instance would exceed MaxCapacity.

Remarks

The Append(Char) 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.

string str = "Characters in a string.";
System.Text.StringBuilder sb = new System.Text.StringBuilder();
foreach (var ch in str)
   sb.Append(" '").Append(ch).Append("' ");

Console.WriteLine("Characters in the string:");
Console.WriteLine("  {0}", sb);
// The example displays the following output:
//    Characters in the string:
//       'C'  'h'  'a'  'r'  'a'  'c'  't'  'e'  'r'  's'  ' '  'i'  'n'  ' '  'a'  ' '  's'  't' 'r'  'i'  'n'  'g'  '.'
let str = "Characters in a string."
let sb = StringBuilder()

for ch in str do
    sb.Append(" '").Append(ch).Append "' " |> ignore

printfn "Characters in the string:"
printfn $"  {sb}"
// The example displays the following output:
//    Characters in the string:
//       'C'  'h'  'a'  'r'  'a'  'c'  't'  'e'  'r'  's'  ' '  'i'  'n'  ' '  'a'  ' '  's'  't' 'r'  'i'  'n'  'g'  '.'
Dim str As String = "Characters in a string."
Dim sb As New System.Text.StringBuilder()
For Each ch In str
   sb.Append(" '").Append(ch).Append("' ")
Next
Console.WriteLine("Characters in the string:")
Console.WriteLine("  {0}", sb)
' The example displays the following output:
'    Characters in the string:
'       'C'  'h'  'a'  'r'  'a'  'c'  't'  'e'  'r'  's'  ' '  'i'  'n'  ' '  'a'  ' '  's'  't' 'r'  'i'  'n'  'g'  '.'

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.

See also

Applies to

Append(Char[])

Appends the string representation of the Unicode characters in a specified array to this instance.

public:
 System::Text::StringBuilder ^ Append(cli::array <char> ^ value);
public System.Text.StringBuilder Append (char[] value);
public System.Text.StringBuilder Append (char[]? value);
member this.Append : char[] -> System.Text.StringBuilder
Public Function Append (value As Char()) As StringBuilder

Parameters

value
Char[]

The array of characters to append.

Returns

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

Exceptions

Enlarging the value of this instance would exceed MaxCapacity.

Remarks

This method appends all the characters in the specified array to the current instance in the same order as they appear in value. If value is null, no changes are made.

The Append(Char[]) 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.

char[] chars = { 'a', 'e', 'i', 'o', 'u' };
System.Text.StringBuilder sb = new System.Text.StringBuilder();
sb.Append("The characters in the array: ").Append(chars);
Console.WriteLine(sb);
// The example displays the following output:
//      The characters in the array: aeiou
let chars = [| 'a'; 'e'; 'i'; 'o'; 'u' |]
let sb = StringBuilder()
sb.Append("The characters in the array: ").Append chars |> ignore
printfn $"{sb}"
// The example displays the following output:
//      The characters in the array: aeiou
Dim chars() As Char = { "a"c, "e"c, "i"c, "o"c, "u"c }
Dim sb As New System.Text.StringBuilder()
sb.Append("The characters in the array: ").Append(chars)
Console.WriteLine(sb)
' The example displays the following output:
'      The characters in the array: aeiou

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

Append(Double)

Appends the string representation of a specified double-precision floating-point number to this instance.

public:
 System::Text::StringBuilder ^ Append(double value);
public System.Text.StringBuilder Append (double value);
member this.Append : double -> System.Text.StringBuilder
Public Function Append (value As Double) As StringBuilder

Parameters

value
Double

The value to append.

Returns

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

Exceptions

Enlarging the value of this instance would exceed MaxCapacity.

Remarks

The Append(Double) 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.

double value = 1034769.47;
System.Text.StringBuilder sb = new System.Text.StringBuilder();
sb.Append('*', 5).Append(value).Append('*', 5);
Console.WriteLine(sb);
// The example displays the following output:
//       *****1034769.47*****
let value = 1034769.47
let sb = StringBuilder()
sb.Append('*', 5).Append(value).Append('*', 5) |> ignore
printfn $"{sb}"
// The example displays the following output:
//       *****1034769.47*****
Dim value As Double = 1034769.47
Dim sb As New System.Text.StringBuilder()
sb.Append("*"c, 5).Append(value).Append("*"c, 5)
Console.WriteLine(sb)
' The example displays the following output:
'       *****1034769.47*****

The Append(Double) method calls the Double.ToString(IFormatProvider) method to get the string representation of value for the current culture. To control the formatting of value, call the AppendFormat method.

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.

See also

Applies to

Append(Decimal)

Appends the string representation of a specified decimal number to this instance.

public:
 System::Text::StringBuilder ^ Append(System::Decimal value);
public System.Text.StringBuilder Append (decimal value);
member this.Append : decimal -> System.Text.StringBuilder
Public Function Append (value As Decimal) As StringBuilder

Parameters

value
Decimal

The value to append.

Returns

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

Exceptions

Enlarging the value of this instance would exceed MaxCapacity.

Remarks

The Append(Decimal) 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.

decimal value = 1346.19m;
System.Text.StringBuilder sb = new System.Text.StringBuilder();
sb.Append('*', 5).Append(value).Append('*', 5);
Console.WriteLine(sb);
// The example displays the following output:
//       *****1346.19*****
let value = 1346.19m
let sb = StringBuilder()
sb.Append('*', 5).Append(value).Append('*', 5) |> ignore
printfn $"{sb}"
// The example displays the following output:
//       *****1346.19*****
Dim value As Decimal = 1346.19d
Dim sb As New System.Text.StringBuilder()
sb.Append("*"c, 5).Append(value).Append("*"c, 5)
Console.WriteLine(sb)
' The example displays the following output:
'       *****1346.19*****

The Append(Decimal) method calls the Decimal.ToString(IFormatProvider) method to get the string representation of value for the current culture. To control the formatting of value, call the AppendFormat method.

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.

See also

Applies to

Append(Int32)

Appends the string representation of a specified 32-bit signed integer to this instance.

public:
 System::Text::StringBuilder ^ Append(int value);
public System.Text.StringBuilder Append (int value);
member this.Append : int -> System.Text.StringBuilder
Public Function Append (value As Integer) As StringBuilder

Parameters

value
Int32

The value to append.

Returns

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

Exceptions

Enlarging the value of this instance would exceed MaxCapacity.

Remarks

The Append(Int32) 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.

System.Text.StringBuilder sb = new 
       System.Text.StringBuilder("The range of a 32-bit integer: ");
sb.Append(Int32.MinValue).Append(" to ").Append(Int32.MaxValue);
Console.WriteLine(sb);
// The example displays the following output:
//       The range of a 32-bit integer: -2147483648 to 2147483647
let sb = StringBuilder "The range of a 32-bit integer: "
sb.Append(Int32.MinValue).Append(" to ").Append Int32.MaxValue |> ignore
printfn $"{sb}"
// The example displays the following output:
//       The range of a 32-bit integer: -2147483648 to 2147483647
Dim sb As New System.Text.StringBuilder("The range of a 32-bit integer: ")
sb.Append(Int32.MinValue).Append(" to ").Append(Int32.MaxValue)
Console.WriteLine(sb)
' The example displays the following output:
'       The range of a 32-bit integer: -2147483648 to 2147483647

The Append(Int32) method calls the Int32.ToString(IFormatProvider) method to get the string representation of value for the current culture. To control the formatting of value, call the AppendFormat method.

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.

See also

Applies to

Append(Int64)

Appends the string representation of a specified 64-bit signed integer to this instance.

public:
 System::Text::StringBuilder ^ Append(long value);
public System.Text.StringBuilder Append (long value);
member this.Append : int64 -> System.Text.StringBuilder
Public Function Append (value As Long) As StringBuilder

Parameters

value
Int64

The value to append.

Returns

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

Exceptions

Enlarging the value of this instance would exceed MaxCapacity.

Remarks

The Append(Int64) 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.

System.Text.StringBuilder sb = new 
            System.Text.StringBuilder("The range of a 64-bit integer: ");
sb.Append(Int64.MinValue).Append(" to ").Append(Int64.MaxValue);
Console.WriteLine(sb);
// The example displays the following output:
//       The range of a 64-bit integer:  -9223372036854775808 to 9223372036854775807
let sb = StringBuilder "The range of a 64-bit integer: "
sb.Append(Int64.MinValue).Append(" to ").Append Int64.MaxValue |> ignore
printfn $"{sb}"
// The example displays the following output:
//       The range of a 64-bit integer:  -9223372036854775808 to 9223372036854775807
Dim sb As New System.Text.StringBuilder("The range of a 64-bit integer: ")
sb.Append(Int64.MinValue).Append(" to ").Append(Int64.MaxValue)
Console.WriteLine(sb)
' The example displays the following output:
'       The range of a 64-bit integer:  -9223372036854775808 to 9223372036854775807

The Append(Int64) method calls the Int64.ToString(IFormatProvider) to get the string representation of value for the current culture. To control the formatting of value, call the AppendFormat method.

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.

See also

Applies to

Append(Object)

Appends the string representation of a specified object to this instance.

public:
 System::Text::StringBuilder ^ Append(System::Object ^ value);
public System.Text.StringBuilder Append (object value);
public System.Text.StringBuilder Append (object? value);
member this.Append : obj -> System.Text.StringBuilder
Public Function Append (value As Object) As StringBuilder

Parameters

value
Object

The object to append.

Returns

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

Exceptions

Enlarging the value of this instance would exceed MaxCapacity.

Remarks

The Append(Object) 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. It defines a Dog class, creates a Dog object, and makes three calls to the Append method to create a string that contains the dog's name and breed.

using System;

public class Dog
{
   private string dogBreed;
   private string dogName;
   
   public Dog(string name, string breed)
   {
      this.dogName = name;
      this.dogBreed = breed;
   }
   
   public string Breed {
      get { return this.dogBreed; }
   }
   
   public string Name {
      get { return this.dogName; }
   }
   
   public override string ToString()
   {
      return this.dogName;
   }
}

public class Example
{
   public static void Main()
   {
      Dog dog1 = new Dog("Yiska", "Alaskan Malamute");
      System.Text.StringBuilder sb = new System.Text.StringBuilder();     
      sb.Append(dog1).Append(", Breed: ").Append(dog1.Breed);  
      Console.WriteLine(sb);
   }
}
// The example displays the following output:
//        Yiska, Breed: Alaskan Malamute
open System.Text

type Dog(name: string, breed: string) =
    member _.Name = name
    member _.Breed = breed
    override _.ToString() = name

let dog1 = Dog("Yiska", "Alaskan Malamute")
let sb = StringBuilder()
sb.Append(dog1).Append(", Breed: ").Append dog1.Breed |> printfn "%O"

// The example displays the following output:
//        Yiska, Breed: Alaskan Malamute
Public Class Dog
   Private dogBreed As String
   Private dogName As String
   
   Public Sub New(name As String, breed As String)
      Me.dogName = name
      Me.dogBreed = breed
   End Sub
   
   Public ReadOnly Property Breed As String
      Get
         Return Me.dogBreed
      End Get
   End Property
   
   Public ReadOnly Property Name As String
      Get
         Return Me.dogName
      End Get
   End Property
   
   Public Overrides Function ToString() As String
      Return Me.dogName
   End Function
End Class
   
Module Example
   Public Sub Main()
      Dim dog1 As New Dog("Yiska", "Alaskan Malamute")
      Dim sb As New System.Text.StringBuilder()     
      sb.Append(dog1).Append(", Breed: ").Append(dog1.Breed)  
      Console.WriteLine(sb)
   End Sub
End Module
' The example displays the following output:
'       Yiska, Breed: Alaskan Malamute

The Append(Object) method calls the Object.ToString method to get the string representation of value. If value is null, no changes are made to the StringBuilder object.

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.

See also

Applies to

Append(ReadOnlyMemory<Char>)

Appends the string representation of a specified read-only character memory region to this instance.

public:
 System::Text::StringBuilder ^ Append(ReadOnlyMemory<char> value);
public System.Text.StringBuilder Append (ReadOnlyMemory<char> value);
member this.Append : ReadOnlyMemory<char> -> System.Text.StringBuilder
Public Function Append (value As ReadOnlyMemory(Of Char)) As StringBuilder

Parameters

value
ReadOnlyMemory<Char>

The read-only character memory region to append.

Returns

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

Applies to

Append(Int16)

Appends the string representation of a specified 16-bit signed integer to this instance.

public:
 System::Text::StringBuilder ^ Append(short value);
public System.Text.StringBuilder Append (short value);
member this.Append : int16 -> System.Text.StringBuilder
Public Function Append (value As Short) As StringBuilder

Parameters

value
Int16

The value to append.

Returns

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

Exceptions

Enlarging the value of this instance would exceed MaxCapacity.

Remarks

The Append(Int16) 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.

System.Text.StringBuilder sb = new 
       System.Text.StringBuilder("The range of a 16-bit integer: ");
sb.Append(Int16.MinValue).Append(" to ").Append(Int16.MaxValue);
Console.WriteLine(sb);
// The example displays the following output:
//       The range of a 16-bit integer: -32768 to 32767
let sb = StringBuilder "The range of a 16-bit integer: "
sb.Append(Int16.MinValue).Append(" to ").Append Int16.MaxValue |> ignore
printfn $"{sb}"
// The example displays the following output:
//       The range of a 16-bit integer: -32768 to 32767
Dim sb As New System.Text.StringBuilder("The range of a 16-bit integer: ")
sb.Append(Int16.MinValue).Append(" to ").Append(Int16.MaxValue)
Console.WriteLine(sb)
' The example displays the following output:
'       The range of a 16-bit integer: -32768 to 32767

The Append(Int16) method calls the Int16.ToString(IFormatProvider) method to get the string representation of value for the current culture. To control the formatting of value, call the AppendFormat method.

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.

See also

Applies to