This documentation is archived and is not being maintained.

StringBuilder.Clear Method

Removes all characters from the current StringBuilder instance.

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

Public Function Clear As StringBuilder

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.

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)

      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)

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, 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.