StringBuilder.ToString Method

Definition

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()

Source:
StringBuilder.cs
Source:
StringBuilder.cs
Source:
StringBuilder.cs

Converts the value of this instance to a String.

public override string ToString ();

Returns

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());

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

.NET 9 and other versions
Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0

ToString(Int32, Int32)

Source:
StringBuilder.cs
Source:
StringBuilder.cs
Source:
StringBuilder.cs

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

public string ToString (int startIndex, int length);

Parameters

startIndex
Int32

The starting position of the substring in this instance.

length
Int32

The length of the substring.

Returns

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

Exceptions

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

.NET 9 and other versions
Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0