Windows Dev Center

StringBuilder.Append Method (Object)

Appends the string representation of a specified object to the end of 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 its maximum capacity.

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 Demo(outputBlock As System.Windows.Controls.TextBlock)
      Dim dog1 As New Dog("Yiska", "Alaskan Malamute")
      Dim sb As New System.Text.StringBuilder()     
      sb.Append(dog1).Append(", Breed: ").Append(dog1.Breed)  
      outputBlock.Text += sb.ToString() + Environment.NewLine
   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.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Show:
© 2015 Microsoft