This documentation is archived and is not being maintained.

StringBuilder.Append Method (String)

.NET Framework 1.1

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

[Visual Basic]
Overloads Public Function Append( _
   ByVal value As String _
) As StringBuilder
[C#]
public StringBuilder Append(
 string value
);
[C++]
public: StringBuilder* Append(
 String* value
);
[JScript]
public function Append(
   value : String
) : StringBuilder;

Parameters

value
The String to append.

Return Value

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

Exceptions

Exception Type Condition
ArgumentOutOfRangeException Enlarging the value of this instance would exceed MaxCapacity.

Remarks

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

The capacity is adjusted as needed.

Example

[Visual Basic] 
' This example demonstrates StringBuilder.Append()
Imports System
Imports System.Text

Class Sample
   Public Shared Sub Main()
      Dim sep As String = ", "
      Dim head As String = "<<<"
      Dim tail As Char() =  {">"c, ">"c, ">"c}
      Dim dash As Char = "-"c
      Dim obj As [Object] = 0
      
      Dim xBool As Boolean = True
      Dim xByte As Byte = 1
      Dim xInt16 As Short = 2
      Dim xInt32 As Integer = 3
      Dim xInt64 As Long = 4
      Dim xDecimal As [Decimal] = 5
      Dim xSingle As Single = 6.6F
      Dim xDouble As Double = 7.7
      
      ' The following types are not CLS-compliant.
      ' Dim xUInt16 As System.UInt16 = 8
      ' Dim xUInt32 As System.UInt32 = 9
      ' Dim xUInt64 As System.UInt64 = 10
      ' Dim xSByte As System.SByte = - 11
      '
      Dim sb As New StringBuilder()
      
      sb = sb.Append(head)              ' <<<
      sb = sb.Append(head, 2, 1)        ' <<<<
      sb = sb.Append(dash)              ' <<<<-
      sb = sb.Append(dash).Append(dash) ' <<<<---
      sb = sb.Append(xBool).Append(sep)
      sb = sb.Append(obj).Append(sep).Append(xByte).Append(sep)
      sb = sb.Append(xInt16)
      sb = sb.Append(sep)
      sb = sb.Append(xInt32)
      sb = sb.Append(sep)
      sb = sb.Append(xInt64)
      sb = sb.Append(sep)
      sb = sb.Append(xDecimal).Append(sep)
      sb = sb.Append(xSingle).Append(sep).Append(xDouble)
      
      ' The following Append methods are not CLS-compliant.
      ' sb.Append(xUInt16)
      ' sb.Append(xUInt32)
      ' sb.Append(xUInt64)
      ' sb.Append(xSByte)
      '
      sb = sb.Append(dash, 3)           ' ---
      sb = sb.Append(tail)              ' --->>>
      sb = sb.Append(tail, 2, 1)        ' --->>>>
      Dim str As [String] = sb.ToString()
      Console.WriteLine("The appended string is:")
      Console.WriteLine(str)
   End Sub 'Main
End Class 'Sample
'
'This example produces the following results:
'The appended string is:
'<<<<---True, 0, 1, 2, 3, 4, 5, 6.6, 7.7--->>>>
'

[C#] 
// This example demonstrates StringBuilder.Append()
using System;
using System.Text;

class Sample 
{
    public static void Main() 
    {
    string      sep       = ", ";
    string      head      = "<<<";
    char[]      tail      = {'>', '>', '>'};
    char        dash      = '-';
    Object     obj       = 0;

    bool        xBool     = true;
    byte        xByte     = 1;
    short       xInt16    = 2;
    int         xInt32    = 3;
    long        xInt64    = 4;
    Decimal     xDecimal  = 5;
    float       xSingle   = 6.6F;
    double      xDouble   = 7.7;

// The following types are not CLS-compliant.
    ushort      xUInt16   = 8;
    uint        xUInt32   = 9;
    ulong       xUInt64   = 10;
    sbyte       xSByte    = -11;
//
    StringBuilder sb = new StringBuilder();

    sb = sb.Append(head);                // <<<
    sb = sb.Append(head, 2, 1);          // <<<<
    sb = sb.Append(dash);                // <<<<-
    sb = sb.Append(dash).Append(dash);   // <<<<---

    sb = sb.Append(xBool).Append(sep);
    sb = sb.Append(obj).Append(sep).Append(xByte).Append(sep);
    sb = sb.Append(xInt16);
    sb = sb.Append(sep);
    sb = sb.Append(xInt32);
    sb = sb.Append(sep);
    sb = sb.Append(xInt64);
    sb = sb.Append(sep);
    sb = sb.Append(xDecimal).Append(sep);
    sb = sb.Append(xSingle).Append(sep).Append(xDouble).Append(sep);

// The following Append methods are not CLS-compliant.
    sb = sb.Append(xUInt16).Append(sep);
    sb = sb.Append(xUInt32).Append(sep).Append(xUInt64).Append(sep);
    sb = sb.Append(xSByte);
//
    sb = sb.Append(dash, 3);             // ---
    sb = sb.Append(tail);                // --->>>
    sb = sb.Append(tail, 2, 1);          // --->>>>
   
    String str = sb.ToString();
    Console.WriteLine("The appended string is:");
    Console.WriteLine(str);
    }
}
/*
This example produces the following results:
The appended string is:
<<<<---True, 0, 1, 2, 3, 4, 5, 6.6, 7.7, 8, 9, 10, -11--->>>>
*/

[C++] 
// This example demonstrates StringBuilder.Append()
#using <mscorlib.dll>
using namespace System;
using namespace System::Text;

int main() 
{
    String*     sep       = S", ";
    String*     head      = S"<<<";
    Char tail[]           = {'>', '>', '>'};
    Char        dash      = '-';
    Object*     obj       = __box(0);

    bool        xBool     = true;
    Byte        xByte     = 1;
    short       xInt16    = 2;
    int         xInt32    = 3;
    long        xInt64    = 4;
    Decimal     xDecimal  = 5;
    float       xSingle   = 6.6F;
    double      xDouble   = 7.7;

// The following types are not CLS-compliant.
    UInt16      xUInt16   = 8;
    UInt32      xUInt32   = 9;
    UInt64      xUInt64   = 10;
    SByte       xSByte    = -11;
//
    StringBuilder* sb = new StringBuilder();

    sb = sb->Append(head);                // <<<
    sb = sb->Append(head, 2, 1);          // <<<<
    sb = sb->Append(dash);                // <<<<-
    sb = sb->Append(dash)->Append(dash);  // <<<<---

    sb = sb->Append(xBool)->Append(sep);
    sb = sb->Append(obj)->Append(sep)->Append(xByte)->Append(sep);
    sb = sb->Append(xInt16);
    sb = sb->Append(sep);
    sb = sb->Append(xInt32);
    sb = sb->Append(sep);
    sb = sb->Append(xInt64);
    sb = sb->Append(sep);
    sb = sb->Append(xDecimal)->Append(sep);
    sb = sb->Append(xSingle)->Append(sep)->Append(xDouble)->Append(sep);

// The following Append methods are not CLS-compliant.
    sb = sb->Append(xUInt16)->Append(sep);
    sb = sb->Append(xUInt32)->Append(sep)->Append(xUInt64)->Append(sep);
    sb = sb->Append(xSByte);
//
    sb = sb->Append(dash, 3);             // ---
    sb = sb->Append(tail);                // --->>>
    sb = sb->Append(tail, 2, 1);          // --->>>>
   
    String* str = sb->ToString();
    Console::WriteLine(S"The appended string is:");
    Console::WriteLine(str);
}
/*
This example produces the following results:
The appended string is:
<<<<---True, 0, 1, 2, 3, 4, 5, 6.6, 7.7, 8, 9, 10, -11--->>>>
*/

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework, Common Language Infrastructure (CLI) Standard

See Also

StringBuilder Class | StringBuilder Members | System.Text Namespace | StringBuilder.Append Overload List | String

Show: