Int16.ToString Method (String, IFormatProvider)

Microsoft Silverlight will reach end of support after October 2021. Learn more.

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

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

Syntax

'Declaration
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)

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 nulla null reference (Nothing in Visual Basic) or an empty string (""), the string returned by this method 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. Its GetFormat method returns a NumberFormatInfo object that provides culture-specific information about the format of the string that is returned by this method. The object that implements IFormatProvider can be any of the following:

  • A CultureInfo object that represents the culture whose formatting rules are to be used.

  • A NumberFormatInfo object that contains specific numeric formatting information for this value.

  • A custom object that implements IFormatProvider.

If provider is nulla null reference (Nothing in Visual Basic), or a NumberFormatInfo object cannot be obtained from provider, the return value is formatted with the NumberFormatInfo for the current culture.

Examples

The following example displays an Int16 value using each of the supported standard format strings in four different cultures.

Dim value As Int16 = 14603
Dim formats() As String = {"C", "D6", "e1", "E2", "F1", "G", "N1", _
                           "P0", "X4", "000000.0000", "##000.0"}
Dim providers() As CultureInfo = {New CultureInfo("en-us"), _
                                  New CultureInfo("fr-fr"), _
                                  New CultureInfo("de-de"), _
                                  New CultureInfo("es-es")}
' Display header.
outputBlock.Text += String.Format("{0,24}{1,14}{2,14}{3,14}", providers(0), providers(1), _
                  providers(2), providers(3)) & vbCrLf
outputBlock.Text &= vbCrLf
' Display a value using each format string.
For Each format As String In formats
   ' Display the value for each provider on the same line.
   outputBlock.Text += String.Format("{0,-12}", format)
   For Each provider As CultureInfo In providers
      outputBlock.Text += String.Format("{0,12}  ", _
                    value.ToString(format, provider))
   Next
   outputBlock.Text &= vbCrLf
Next
' The example displays the following output:
'                       en-US         fr-FR         de-DE         es-ES
'    
'    C             $14,603.00   14 603,00 €   14.603,00 €   14.603,00 €  
'    D6                014603        014603        014603        014603  
'    e1              1.5e+004      1,5e+004      1,5e+004      1,5e+004  
'    E2             1.46E+004     1,46E+004     1,46E+004     1,46E+004  
'    F1               14603.0       14603,0       14603,0       14603,0  
'    G                  14603         14603         14603         14603  
'    N1              14,603.0      14 603,0      14.603,0      14.603,0  
'    P0           1,460,300 %   1 460 300 %    1.460.300%   1.460.300 %  
'    X4                  390B          390B          390B          390B  
'    000000.0000  014603.0000   014603,0000   014603,0000   014603,0000  
'    ##000.0          14603.0       14603,0       14603,0       14603,0  
Int16 value = 14603;
string[] formats = {"C", "D6", "e1", "E2", "F1", "G", "N1", 
                    "P0", "X4", "000000.0000", "##000.0"};
CultureInfo[] providers = {new CultureInfo("en-us"), 
                           new CultureInfo("fr-fr"), 
                           new CultureInfo("de-de"), 
                           new CultureInfo("es-es")};
// Display header.
outputBlock.Text += String.Format("{0,24}{1,14}{2,14}{3,14}", providers[0], providers[1],
                  providers[2], providers[3]) + "\n";
outputBlock.Text += "\n";
// Display a value using each format string.
foreach (string format in formats)
{
   // Display the value for each provider on the same line.
   outputBlock.Text += String.Format("{0,-12}", format);
   foreach (CultureInfo provider in providers)
   {
      outputBlock.Text += String.Format("{0,12}  ",
                    value.ToString(format, provider));
   }
   outputBlock.Text += "\n";
}
// The example displays the following output:
//                       en-US         fr-FR         de-DE         es-ES
//    
//    C             $14,603.00   14 603,00 €   14.603,00 €   14.603,00 €  
//    D6                014603        014603        014603        014603  
//    e1              1.5e+004      1,5e+004      1,5e+004      1,5e+004  
//    E2             1.46E+004     1,46E+004     1,46E+004     1,46E+004  
//    F1               14603.0       14603,0       14603,0       14603,0  
//    G                  14603         14603         14603         14603  
//    N1              14,603.0      14 603,0      14.603,0      14.603,0  
//    P0           1,460,300 %   1 460 300 %    1.460.300%   1.460.300 %  
//    X4                  390B          390B          390B          390B  
//    000000.0000  014603.0000   014603,0000   014603,0000   014603,0000  
//    ##000.0          14603.0       14603,0       14603,0       14603,0  

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.