Decimal.ToString Method (String)

 

Converts the numeric value of this instance to its equivalent string representation, using the specified format.

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

Public Function ToString (
	format As String
) As String

Parameters

format
Type: System.String

A standard or custom numeric format string (see Remarks).

Return Value

Type: System.String

The string representation of the value of this instance as specified by format.

Exception Condition
FormatException

format is invalid.

The ToString(String) method formats a Decimal value in a specified format by using the conventions of the current culture. If you want to use the default ("G", or general) format or specify a different culture, use the other overloads of the ToString method, as follows:

To use format

For culture

Use the overload

Default ("G") format

Default (current) culture

ToString()

Default ("G") format

A specific culture

ToString(IFormatProvider)

A specific format

A specific culture

ToString(String, IFormatProvider)

The ToString method uses the standard or custom numeric format string specified by the format parameter to convert the value of the current instance into its string representation. The format parameter can be any valid standard numeric format specifier except for D, R, and X, as well as any combination of custom numeric format specifiers. If format is null or an empty string, the return value of this instance is formatted with the general numeric format specifier (G).

The .NET Framework provides extensive formatting support, which is described in greater detail in the following formatting topics:

The return value is formatted by using the NumberFormatInfo object for the current culture. To apply the formatting conventions of a specified culture, call the ToString(String, IFormatProvider) method.

The following example displays a Decimal value using each of the supported standard numeric format specifiers, together with two custom numeric format strings. In converting the numeric values to strings, the example uses the formatting conventions of the en-US culture.

Dim value As Decimal = 16325.62d
Dim specifier As String

' Use standard numeric format specifiers.
specifier = "G"
Console.WriteLine("{0}: {1}", specifier, value.ToString(specifier))
' Displays:    G: 16325.62
specifier = "C"
Console.WriteLine("{0}: {1}", specifier, value.ToString(specifier))
' Displays:    C: $16,325.62
specifier = "E04"
Console.WriteLine("{0}: {1}", specifier, value.ToString(specifier))
' Displays:    E04: 1.6326E+004
specifier = "F"
Console.WriteLine("{0}: {1}", specifier, value.ToString(specifier))
' Displays:    F: 16325.62
specifier = "N"
Console.WriteLine("{0}: {1}", specifier, value.ToString(specifier))
' Displays:    N: 16,325.62
specifier = "P"
Console.WriteLine("{0}: {1}", specifier, (value/10000).ToString(specifier))
' Displays:    P: 163.26 %

' Use custom numeric format specifiers.
specifier = "0,0.000"
Console.WriteLine("{0}: {1}", specifier, value.ToString(specifier))
' Displays:    0,0.000: 16,325.620
specifier = "#,#.00#;(#,#.00#)"
Console.WriteLine("{0}: {1}", specifier, (value*-1).ToString(specifier))
' Displays:    #,#.00#;(#,#.00#): (16,325.62)

Universal Windows Platform
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Show: