Export (0) Print
Expand All

StringBuilder.Append Method (Object)

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

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

'Declaration
Public Function Append ( _
	value As Object _
) As StringBuilder

Parameters

value
Type: System.Object
The object to append.

Return Value

Type: System.Text.StringBuilder
A reference to this instance after the append operation has completed.

ExceptionCondition
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. 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.


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 method calls the Object.ToString method to get the string representation of value. If value is Nothing, no changes are made to the StringBuilder object.

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 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 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.

Community Additions

ADD
Show:
© 2014 Microsoft