StringBuilder.Clear Method

Definition

Namespace:

System.Text

Assembly:

System.Runtime.dll

Source:

StringBuilder.cs

Removes all characters from the current StringBuilder instance.

public:
 System::Text::StringBuilder ^ Clear();

public System.Text.StringBuilder Clear ();

member this.Clear : unit -> System.Text.StringBuilder

Public Function Clear () As StringBuilder

Returns

StringBuilder

An object whose Length is 0 (zero).

Examples

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 Class1
{
   public static void Main()
   {
      StringBuilder sb = new StringBuilder("This is a string.");
      Console.WriteLine("{0} ({1} characters)", sb.ToString(), sb.Length);
      
      sb.Clear();
      Console.WriteLine("{0} ({1} characters)", sb.ToString(), sb.Length);

      sb.Append("This is a second string.");
      Console.WriteLine("{0} ({1} characters)", sb.ToString(), sb.Length);
   }
}
// The example displays the following output:
//       This is a string. (17 characters)
//        (0 characters)
//       This is a second string. (24 characters)

open System.Text

let sb = StringBuilder "This is a string."
printfn $"{sb} ({sb.Length} characters)"

sb.Clear() |> ignore
printfn $"{sb} ({sb.Length} characters)"

sb.Append "This is a second string." |> ignore
printfn $"{sb} ({sb.Length} characters)"

// The example displays the following output:
//       This is a string. (17 characters)
//        (0 characters)
//       This is a second string. (24 characters)

Imports System.Text

Module Example
   Public Sub Main()
      Dim sb As New StringBuilder("This is a string.")
      Console.WriteLine("{0} ({1} characters)", sb.ToString(), sb.Length)
      
      sb.Clear()
      Console.WriteLine("{0} ({1} characters)", sb.ToString(), sb.Length)

      sb.Append("This is a second string.")
      Console.WriteLine("{0} ({1} characters)", sb.ToString(), sb.Length)
   End Sub            
End Module
' The example displays the following output:
'       This is a string. (17 characters)
'        (0 characters)
'       This is a second string. (24 characters)

Remarks

Clear is a convenience method that is equivalent to setting the Length property of the current instance to 0 (zero).