Export (0) Print
Expand All
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

StringBuilder.Append Method (Object)

July 28, 2014

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

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

public StringBuilder Append(
	Object value
)

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.


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 Demo(System.Windows.Controls.TextBlock outputBlock)
   {
      Dog dog1 = new Dog("Yiska", "Alaskan Malamute");
      System.Text.StringBuilder sb = new System.Text.StringBuilder();     
      sb.Append(dog1).Append(", Breed: ").Append(dog1.Breed);  
      outputBlock.Text += sb + Environment.NewLine;
   }
}
// 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 null, 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:
© 2014 Microsoft