Article
11/18/2011

Byte.ToString Method (String, IFormatProvider)

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

Converts the value of the current Byte object to its equivalent string representation using the specified format and culture-specific formatting information.

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

Syntax

'Declaration
<SecuritySafeCriticalAttribute> _
Public Function ToString ( _
    format As String, _
    provider As IFormatProvider _
) As String

[SecuritySafeCriticalAttribute]
public string ToString(
    string format,
    IFormatProvider provider
)

Parameters

format
Type: System.String
A standard or custom numeric format string.

provider
Type: System.IFormatProvider
An IFormatProvider object that supplies culture-specific formatting information.

Return Value

Type: System.String
The string representation of the current Byte object, formatted as specified by the format and provider parameters.

Implements

IFormattable.ToString(String, IFormatProvider)

Exceptions

Exception	Condition
FormatException	format includes an unsupported specifier. Supported format specifiers are listed in the Remarks section.

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 return value of this method 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 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 using the NumberFormatInfo object for the thread current culture. For information about the thread current culture, see Thread.CurrentCulture.

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

For more information about numeric format specifiers, see Standard Numeric Format Strings and Custom Numeric Format Strings.
For more information about formatting, see Formatting Types.

Examples

The following example uses the standard "N" format string and four different CultureInfo objects to display the string representation of a byte value to the console.

Dim byteValue As Byte = 250
Dim providers() As CultureInfo = {New CultureInfo("en-us"), _
                                  New CultureInfo("fr-fr"), _
                                  New CultureInfo("es-es"), _
                                  New CultureInfo("de-de")}
For Each provider As CultureInfo In providers
   outputBlock.Text &= String.Format("{0} ({1}) & vbCrLf", _
                     byteValue.ToString("N2", provider), provider.Name)
Next
' The example displays the following output:
'       250.00 (en-US)
'       250,00 (fr-FR)
'       250,00 (es-ES)
'       250,00 (de-DE)

byte byteValue = 250;
CultureInfo[] providers = {new CultureInfo("en-us"), 
                           new CultureInfo("fr-fr"), 
                           new CultureInfo("es-es"), 
                           new CultureInfo("de-de")};

foreach (CultureInfo provider in providers)
   outputBlock.Text += String.Format("{0} ({1})",
                     byteValue.ToString("N2", provider), provider.Name) + "\n";
// The example displays the following output:
//       250.00 (en-US)
//       250,00 (fr-FR)
//       250,00 (es-ES)
//       250,00 (de-DE)

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.

Share via