StringBuilder.Clear Method

July 28, 2014

Removes all characters from the current StringBuilder instance.

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

public StringBuilder Clear()

Return Value

Type: System.Text.StringBuilder
An object whose Length is 0 (zero).

Clear is a convenience method that is equivalent to setting the Length property of the current instance to 0 (zero). Calling the Clear method does not modify the current instance's Capacity and MaxCapacity properties.

The following example instantiates a StringBuilder object with a string, calls the Clear method, and then appends a new string.


using System;
using System.Text;

public class Example
{
   public static void Demo(System.Windows.Controls.TextBlock outputBlock)
   {
      StringBuilder sb = new StringBuilder("This is a string.");
      outputBlock.Text += String.Format("{0} ({1} characters)", sb.ToString(), sb.Length) + "\n";

      sb.Clear();
      outputBlock.Text += String.Format("{0} ({1} characters)", sb.ToString(), sb.Length) + "\n";

      sb.Append("This is a second string.");
      outputBlock.Text += String.Format("{0} ({1} characters)", sb.ToString(), sb.Length) + "\n";
   }
}
// The example displays the following output:
//       This is a string. (17 characters)
//        (0 characters)
//       This is a second string. (24 characters)


Windows Phone OS

Supported in: 8.1, 8.0, 7.1

Windows Phone

Show:
© 2014 Microsoft