Int32.ToString Method (String, IFormatProvider)

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

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)

Syntax

Public Function ToString ( _
    format As String, _
    provider As IFormatProvider _
) As String
public string ToString(
    string format,
    IFormatProvider provider
)

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 and provider.

Implements

IFormattable..::.ToString(String, IFormatProvider)

Exceptions

Exception Condition
FormatException

format is invalid or not supported.

Remarks

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 nullNothingnullptra 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 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 nullNothingnullptra null reference (Nothing in Visual Basic) 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:

Examples

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

' Define cultures whose formatting conventions are to be used.
Dim cultures() As CultureInfo = {New CultureInfo("en-US"), _
                                 New CultureInfo("fr-FR"), _
                                 New CultureInfo("es-ES")}
Dim positiveNumber As Integer = 1679
Dim negativeNumber As Integer = -3045
Dim specifiers() As String = {"G", "C", "D8", "E2", "F", "N", "P", "X8"}

For Each specifier As String In specifiers
   For Each culture As CultureInfo In cultures
      ' Display values with "G" format specifier.
      outputBlock.Text += String.Format("{0} format using {1} culture: {2, 16} {3, 16}", _
                        specifier, culture.Name, _
                        positiveNumber.ToString(specifier, culture), _
                        negativeNumber.ToString(specifier, culture)) & vbCrLf

   Next
   outputBlock.Text &= vbCrLf
Next
' The example displays the following output:
'       G format using en-US culture:             1679            -3045
'       G format using fr-FR culture:             1679            -3045
'       G format using es-ES culture:             1679            -3045
'       
'       C format using en-US culture:        $1,679.00      ($3,045.00)
'       C format using fr-FR culture:       1 679,00 €      -3 045,00 €
'       C format using es-ES culture:       1.679,00 €      -3.045,00 €
'       
'       D8 format using en-US culture:         00001679        -00003045
'       D8 format using fr-FR culture:         00001679        -00003045
'       D8 format using es-ES culture:         00001679        -00003045
'       
'       E2 format using en-US culture:        1.68E+003       -3.05E+003
'       E2 format using fr-FR culture:        1,68E+003       -3,05E+003
'       E2 format using es-ES culture:        1,68E+003       -3,05E+003
'       
'       F format using en-US culture:          1679.00         -3045.00
'       F format using fr-FR culture:          1679,00         -3045,00
'       F format using es-ES culture:          1679,00         -3045,00
'       
'       N format using en-US culture:         1,679.00        -3,045.00
'       N format using fr-FR culture:         1 679,00        -3 045,00
'       N format using es-ES culture:         1.679,00        -3.045,00
'       
'       P format using en-US culture:     167,900.00 %    -304,500.00 %
'       P format using fr-FR culture:     167 900,00 %    -304 500,00 %
'       P format using es-ES culture:     167.900,00 %    -304.500,00 %
'       
'       X8 format using en-US culture:         0000068F         FFFFF41B
'       X8 format using fr-FR culture:         0000068F         FFFFF41B
'       X8 format using es-ES culture:         0000068F         FFFFF41B
// Define cultures whose formatting conventions are to be used.
CultureInfo[] cultures = {new CultureInfo("en-US"), 
                          new CultureInfo("fr-FR"), 
                          new CultureInfo("es-ES") };
int positiveNumber = 1679;
int negativeNumber = -3045;
string[] specifiers = { "G", "C", "D8", "E2", "F", "N", "P", "X8" };

foreach (string specifier in specifiers)
{
   foreach (CultureInfo culture in cultures)
   {
      // Display values with "G" format specifier.
      outputBlock.Text += String.Format("{0} format using {1} culture: {2, 16} {3, 16}",
                        specifier, culture.Name,
                        positiveNumber.ToString(specifier, culture),
                        negativeNumber.ToString(specifier, culture)) + "\n";
   }
   outputBlock.Text += "\n";
}
// The example displays the following output:
//       G format using en-US culture:             1679            -3045
//       G format using fr-FR culture:             1679            -3045
//       G format using es-ES culture:             1679            -3045
//       
//       C format using en-US culture:        $1,679.00      ($3,045.00)
//       C format using fr-FR culture:       1 679,00 €      -3 045,00 €
//       C format using es-ES culture:       1.679,00 €      -3.045,00 €
//       
//       D8 format using en-US culture:         00001679        -00003045
//       D8 format using fr-FR culture:         00001679        -00003045
//       D8 format using es-ES culture:         00001679        -00003045
//       
//       E2 format using en-US culture:        1.68E+003       -3.05E+003
//       E2 format using fr-FR culture:        1,68E+003       -3,05E+003
//       E2 format using es-ES culture:        1,68E+003       -3,05E+003
//       
//       F format using en-US culture:          1679.00         -3045.00
//       F format using fr-FR culture:          1679,00         -3045,00
//       F format using es-ES culture:          1679,00         -3045,00
//       
//       N format using en-US culture:         1,679.00        -3,045.00
//       N format using fr-FR culture:         1 679,00        -3 045,00
//       N format using es-ES culture:         1.679,00        -3.045,00
//       
//       P format using en-US culture:     167,900.00 %    -304,500.00 %
//       P format using fr-FR culture:     167 900,00 %    -304 500,00 %
//       P format using es-ES culture:     167.900,00 %    -304.500,00 %
//       
//       X8 format using en-US culture:         0000068F         FFFFF41B
//       X8 format using fr-FR culture:         0000068F         FFFFF41B
//       X8 format using es-ES culture:         0000068F         FFFFF41B

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

See Also

Reference

Int32 Structure

ToString Overload

System Namespace

Parse

Other Resources

Formatting Types

Standard Numeric Format Strings

Custom Numeric Format Strings