UInt32.ToString Method (String)

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

Updated: May 2010

Converts the numeric value of this instance to its equivalent string representation using the specified format.

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

Syntax

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

[SecuritySafeCriticalAttribute]
public string ToString(
    string format
)

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.

Exceptions

Exception	Condition
FormatException	The format parameter is invalid.

Remarks

The format parameter can be any valid standard numeric format specifier, or any combination of custom numeric format specifiers. If format is equal to String.Empty or is nulla null reference (Nothing in Visual Basic), the return value of the current UInt32 object is formatted with the general format specifier ("G"). If format is any other value, the method throws a FormatException.

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 support for formatting in the .NET Framework, see Formatting Types.

Note:
Because the UInt32 data type is not supported on the Macintosh OS X operating system, the string representation of a UInt32 value may be different from those of the other .NET Framework numeric types that are supported by OS X.

The format of the returned string is determined by the NumberFormatInfo object for the current culture. Depending on the format parameter, this object controls symbols such as the group separator and the decimal point symbol in the output string. To provide formatting information for cultures other than the current culture, call the ToString(String, IFormatProvider) overload.

Examples

The following example displays a 32-bit unsigned integer value by using each standard format string and some custom format strings.

Imports System.Globalization

Module Example
   Public Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)
      Dim value As UInteger = 2179608
      Dim specifiers() As String = {"G", "C", "D3", "E2", "e3", "F", _
                                     "N", "P", "X", "000000.0", "#.0", _
                                     "00000000;(0);**Zero**"}

      For Each specifier As String In specifiers
         outputBlock.Text += String.Format("{0}: {1}", specifier, value.ToString(specifier)) & vbCrLf
      Next
   End Sub
End Module
' The example displays the following output:
'       G: 2179608
'       C: $2,179,608.00
'       D3: 2179608
'       E2: 2.18E+006
'       e3: 2.180e+006
'       F: 2179608.00
'       N: 2,179,608.00
'       P: 217,960,800.00 %
'       X: 214218
'       000000.0: 2179608.0
'       #.0: 2179608.0
'       00000000;(0);**Zero**: 02179608

using System;
using System.Globalization;

public class Example
{
   public static void Demo(System.Windows.Controls.TextBlock outputBlock)
   {
      uint value = 2179608;
      string[] specifiers = { "G", "C", "D3", "E2", "e3", "F", 
                              "N", "P", "X", "000000.0", "#.0", 
                              "00000000;(0);**Zero**" };

      foreach (string specifier in specifiers)
         outputBlock.Text += String.Format("{0}: {1}", specifier, value.ToString(specifier)) + "\n";
   }
}
// The example displays the following output:
//       G: 2179608
//       C: $2,179,608.00
//       D3: 2179608
//       E2: 2.18E+006
//       e3: 2.180e+006
//       F: 2179608.00
//       N: 2,179,608.00
//       P: 217,960,800.00 %
//       X: 214218
//       000000.0: 2179608.0
//       #.0: 2179608.0
//       00000000;(0);**Zero**: 02179608

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.

See Also

Reference

UInt32 Structure

ToString Overload

System Namespace

Parse

Other Resources

Formatting Types

How to: Pad a Number with Leading Zeros

Change History

Date	History	Reason
May 2010	Revised extensively.	Information enhancement.