StringBuilder.ToString Method

Definition

Namespace:
System.Text
Assembly:
System.Runtime.dll
Assembly:
mscorlib.dll
Assembly:
netstandard.dll

Converts the value of a StringBuilder to a String.

Overloads

ToString()

Converts the value of this instance to a String.
ToString(Int32, Int32)

Converts the value of a substring of this instance to a String.

ToString()

Converts the value of this instance to a String.

public:
 override System::String ^ ToString();
public override string ToString ();
override this.ToString : unit -> string
Public Overrides Function ToString () As String

Returns

String

A string whose value is the same as this instance.

Examples

The following example demonstrates calling the ToString method. This example is part of a larger example provided for the StringBuilder class.

// Display the number of characters in the StringBuilder
// and its string.
Console::WriteLine("{0} chars: {1}", sb->Length, sb->ToString());

// Display the number of characters in the StringBuilder and its string.
Console.WriteLine("{0} chars: {1}", sb.Length, sb.ToString());

' Display the number of characters in the StringBuilder and its string.
Console.WriteLine("{0} chars: {1}", sb.Length, sb.ToString())

Remarks

You must call the ToString method to convert the StringBuilder object to a String object before you can pass the string represented by the StringBuilder object to a method that has a String parameter or display it in the user interface.

ToString(Int32, Int32)

Converts the value of a substring of this instance to a String.

public:
 System::String ^ ToString(int startIndex, int length);
public string ToString (int startIndex, int length);
override this.ToString : int * int -> string
Public Function ToString (startIndex As Integer, length As Integer) As String

Parameters

startIndex
Int32

The starting position of the substring in this instance.

length
Int32

The length of the substring.

Returns

String

A string whose value is the same as the specified substring of this instance.

Exceptions

ArgumentOutOfRangeException

startIndex or length is less than zero.

-or-

The sum of startIndex and length is greater than the length of the current instance.

Remarks

You must call the ToString method to convert the StringBuilder object to a String object before you can pass the string represented by the StringBuilder object to a method that has a String parameter or display it in the user interface.

Applies to