Int32.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)

abstract ToString : 
        format:string *
        provider:IFormatProvider -> string
override ToString : 
        format:string *
        provider:IFormatProvider -> string

Parameters

format
Type: System.String

A standard or custom numeric format string.

provider
Type: System.IFormatProvider

An object that supplies culture-specific formatting information.

Return Value

Type: System.String

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

Exception Condition
FormatException

format is invalid or not supported.

The ToString(String, IFormatProvider) method formats an Int32 value in a specified format by using the NumberFormatInfo object of a specified culture. If you want to use default format or culture settings, 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

Default (current) culture

ToString(String)

The format parameter can be either a standard or a custom numeric format string. All standard numeric format strings other than "R" (or "r") are supported, as are all custom numeric format characters. If format is null or an empty string (""), the return value for this instance is formatted with the general numeric format specifier ("G").

The provider parameter is an object that implements the IFormatProvider interface. Its GetFormat method returns a NumberFormatInfo object that provides culture-specific format information about the format of the string that is returned by this method. The object that implements IFormatProvider can be any of the following:

If provider is null or a NumberFormatInfo object cannot be obtained from provider, the return value for this instance is formatted with the NumberFormatInfo for the current culture.

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

The following example displays a positive and a negative value using each of the supported standard numeric format specifiers for three different cultures.

No code example is currently available or this language may not be supported.

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: