Decimal.ToString Method (String, IFormatProvider)

Converts the numeric value of this instance to its equivalent string representation using the specified format and culture-specific format information.

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

public string ToString (
	string format,
	IFormatProvider provider
)
public final String ToString (
	String format, 
	IFormatProvider provider
)
public final function ToString (
	format : String, 
	provider : IFormatProvider
) : String
Not applicable.

Parameters

format

A numeric format string.

provider

An IFormatProvider that supplies culture-specific formatting information.

Return Value

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

Exception typeCondition

FormatException

format is invalid.

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 a null reference (Nothing in Visual Basic) or an empty string, the return value for 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 provider parameter is an IFormatProvider implementation whose IFormatProvider.GetFormat method returns a NumberFormatInfo object. Typically, provider is a NumberFormatInfo or CultureInfo object. The provider parameter supplies culture-specific information used in formatting. If provider is a null reference (Nothing in Visual Basic), the thread current culture is used.

The following example displays a Decimal value using each of the supported standard numeric format specifiers for several different cultures.

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0

Community Additions

ADD
Show: