UInt16.ToString Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Converts the numeric value of this instance to its equivalent string representation.
Overloads
ToString(IFormatProvider) |
Converts the numeric value of this instance to its equivalent string representation using the specified culture-specific format information. |
ToString(String) |
Converts the numeric value of this instance to its equivalent string representation using the specified format. |
ToString(String, IFormatProvider) |
Converts the numeric value of this instance to its equivalent string representation using the specified format and culture-specific format information. |
ToString() |
Converts the numeric value of this instance to its equivalent string representation. |
ToString(IFormatProvider)
- Source:
- UInt16.cs
- Source:
- UInt16.cs
- Source:
- UInt16.cs
Converts the numeric value of this instance to its equivalent string representation using the specified culture-specific format information.
public:
virtual System::String ^ ToString(IFormatProvider ^ provider);
public:
System::String ^ ToString(IFormatProvider ^ provider);
public string ToString (IFormatProvider provider);
public string ToString (IFormatProvider? provider);
override this.ToString : IFormatProvider -> string
Public Function ToString (provider As IFormatProvider) As String
Parameters
- provider
- IFormatProvider
An object that supplies culture-specific formatting information.
Returns
The string representation of the value of this instance, which consists of a sequence of digits ranging from 0 to 9, without a sign or leading zeros.
Implements
Examples
The following example formats a 16-bit signed integer value by using several format providers, including one for the invariant culture. The output from the example illustrates that the formatted string returned by the ToString(IFormatProvider) method is the same regardless of the format provider.
using System;
using System.Globalization;
public class Example
{
public static void Main()
{
// Define an array of CultureInfo objects.
CultureInfo[] ci = { new CultureInfo("en-US"),
new CultureInfo("fr-FR"),
CultureInfo.InvariantCulture };
UInt16 value = 18924;
Console.WriteLine(" {0,12} {1,12} {2,12}",
GetName(ci[0]), GetName(ci[1]), GetName(ci[2]));
Console.WriteLine(" {0,12} {1,12} {2,12}",
value.ToString(ci[0]), value.ToString(ci[1]), value.ToString(ci[2]));
}
private static string GetName(CultureInfo ci)
{
if (ci.Equals(CultureInfo.InvariantCulture))
return "Invariant";
else
return ci.Name;
}
}
// The example displays the following output:
// en-US fr-FR Invariant
// 18924 18924 18924
open System.Globalization
let getName (ci: CultureInfo) =
if ci.Equals CultureInfo.InvariantCulture then "Invariant"
else ci.Name
// Define an array of CultureInfo objects.
let ci =
[| CultureInfo "en-US"
CultureInfo "fr-FR"
CultureInfo.InvariantCulture |]
let value = 18924us
printfn $" {getName ci[0],12} {getName ci[1],12} {getName ci[2],12}"
printfn $" {value.ToString ci[0],12} {value.ToString ci[1],12} {value.ToString ci[2],12}"
// The example displays the following output:
// en-US fr-FR Invariant
// 18924 18924 18924
Imports System.Globalization
Module Example
Public Sub Main()
' Define an array of CultureInfo objects.
Dim ci() As CultureInfo = { New CultureInfo("en-US"), _
New CultureInfo("fr-FR"), _
CultureInfo.InvariantCulture }
Dim value As UInt16 = 18924
Console.WriteLine(" {0,12} {1,12} {2,12}", _
GetName(ci(0)), GetName(ci(1)), GetName(ci(2)))
Console.WriteLine(" {0,12} {1,12} {2,12}", _
value.ToString(ci(0)), value.ToString(ci(1)), value.ToString(ci(2)))
End Sub
Private Function GetName(ci As CultureInfo) As String
If ci.Equals(CultureInfo.InvariantCulture) Then
Return "Invariant"
Else
Return ci.Name
End If
End Function
End Module
' The example displays the following output:
' en-US fr-FR Invariant
' 18924 18924 18924
Remarks
The ToString(IFormatProvider) method formats a UInt16 value in the default ("G", or general) format by using the NumberFormatInfo object of a specified culture. If you want to specify a different format or the current culture, 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() |
A specific format | Default (current) culture | ToString(String) |
A specific format | A specific culture | ToString(String, IFormatProvider) |
The provider
parameter is an IFormatProvider implementation. Its GetFormat method returns a NumberFormatInfo object that provides culture-specific formatting information. However, none of the properties of the NumberFormatInfo are used when formatting with the general numeric format specifier ("G").
See also
Applies to
ToString(String)
- Source:
- UInt16.cs
- Source:
- UInt16.cs
- Source:
- UInt16.cs
Converts the numeric value of this instance to its equivalent string representation using the specified format.
public:
System::String ^ ToString(System::String ^ format);
public string ToString (string format);
public string ToString (string? format);
override this.ToString : string -> string
Public Function ToString (format As String) As String
Parameters
- format
- String
A numeric format string.
Returns
The string representation of the value of this instance as specified by format
.
Exceptions
The format
parameter is invalid.
Examples
The following example displays a 16-bit unsigned integer value by using each standard format string and some custom format strings.
using System;
using System.Globalization;
public class Example
{
public static void Main()
{
ushort value = 21708;
string[] specifiers = { "G", "C", "D3", "E2", "e3", "F",
"N", "P", "X", "000000.0", "#.0",
"00000000;(0);**Zero**" };
foreach (string specifier in specifiers)
Console.WriteLine("{0}: {1}", specifier, value.ToString(specifier));
}
}
// The example displays the following output:
// G: 21708
// C: $21,708.00
// D3: 21708
// E2: 2.17E+004
// e3: 2.171e+004
// F: 21708.00
// N: 21,708.00
// P: 2,170,800.00 %
// X: 54CC
// 000000.0: 021708.0
// #.0: 21708.0
// 00000000;(0);**Zero**: 00021708
let value = 21708us
let specifiers =
[| "G"; "C"; "D3"; "E2"; "e3"; "F"
"N"; "P"; "X"; "000000.0"; "#.0"
"00000000(0)**Zero**" |]
for specifier in specifiers do
printfn $"{specifier}: {value.ToString specifier}"
// The example displays the following output:
// G: 21708
// C: $21,708.00
// D3: 21708
// E2: 2.17E+004
// e3: 2.171e+004
// F: 21708.00
// N: 21,708.00
// P: 2,170,800.00 %
// X: 54CC
// 000000.0: 021708.0
// #.0: 21708.0
// 00000000(0)**Zero**: 00021708
Imports System.Globalization
Module Example
Public Sub Main()
Dim value As UShort = 21708
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
Console.WriteLine("{0}: {1}", specifier, value.ToString(specifier))
Next
End Sub
End Module
' The example displays the following output:
' G: 21708
' C: $21,708.00
' D3: 21708
' E2: 2.17E+004
' e3: 2.171e+004
' F: 21708.00
' N: 21,708.00
' P: 2,170,800.00 %
' X: 54CC
' 000000.0: 021708.0
' #.0: 21708.0
' 00000000;(0);**Zero**: 00021708
Remarks
The ToString(String) method formats a UInt16 value in a specified format by using a NumberFormatInfo object that represents the conventions of the current culture. If you want to use the default ("G", or general) format or specify a different culture, 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 | A specific culture | ToString(String, IFormatProvider) |
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 null
, the return value of the current UInt16 object is formatted with the general format specifier ("G"). If format
is any other value, the method throws a FormatException.
.NET 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 .NET, see Formatting Types.
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.
See also
Applies to
ToString(String, IFormatProvider)
- Source:
- UInt16.cs
- Source:
- UInt16.cs
- Source:
- UInt16.cs
Converts the numeric value of this instance to its equivalent string representation using the specified format and culture-specific format information.
public:
virtual System::String ^ ToString(System::String ^ format, IFormatProvider ^ provider);
public string ToString (string format, IFormatProvider provider);
public string ToString (string? format, IFormatProvider? provider);
override this.ToString : string * IFormatProvider -> string
Public Function ToString (format As String, provider As IFormatProvider) As String
Parameters
- format
- String
A numeric format string.
- provider
- IFormatProvider
An object that supplies culture-specific formatting information.
Returns
The string representation of the value of this instance, as specified by format
and provider
.
Implements
Exceptions
format
is invalid.
Examples
The following example displays a 16-bit unsigned integer value by using the standard numeric format specifiers and a number of specific CultureInfo objects.
using System;
using System.Globalization;
public class Example
{
public static void Main()
{
// Define cultures whose formatting conventions are to be used.
CultureInfo[] cultures = { CultureInfo.CreateSpecificCulture("en-US"),
CultureInfo.CreateSpecificCulture("fr-FR"),
CultureInfo.CreateSpecificCulture("es-ES") };
string[] specifiers = {"G", "C", "D4", "E2", "F", "N", "P", "X2"};
ushort value = 22042;
foreach (string specifier in specifiers)
{
foreach (CultureInfo culture in cultures)
Console.WriteLine("{0,2} format using {1} culture: {2, 16}",
specifier, culture.Name,
value.ToString(specifier, culture));
Console.WriteLine();
}
}
}
// The example displays the following output:
// G format using en-US culture: 22042
// G format using fr-FR culture: 22042
// G format using es-ES culture: 22042
//
// C format using en-US culture: $22,042.00
// C format using fr-FR culture: 22 042,00 €
// C format using es-ES culture: 22.042,00 €
//
// D4 format using en-US culture: 22042
// D4 format using fr-FR culture: 22042
// D4 format using es-ES culture: 22042
//
// E2 format using en-US culture: 2.20E+004
// E2 format using fr-FR culture: 2,20E+004
// E2 format using es-ES culture: 2,20E+004
//
// F format using en-US culture: 22042.00
// F format using fr-FR culture: 22042,00
// F format using es-ES culture: 22042,00
//
// N format using en-US culture: 22,042.00
// N format using fr-FR culture: 22 042,00
// N format using es-ES culture: 22.042,00
//
// P format using en-US culture: 2,204,200.00 %
// P format using fr-FR culture: 2 204 200,00 %
// P format using es-ES culture: 2.204.200,00 %
//
// X2 format using en-US culture: 561A
// X2 format using fr-FR culture: 561A
// X2 format using es-ES culture: 561A
open System.Globalization
// Define cultures whose formatting conventions are to be used.
let cultures =
[| CultureInfo.CreateSpecificCulture "en-US"
CultureInfo.CreateSpecificCulture "fr-FR"
CultureInfo.CreateSpecificCulture "es-ES" |]
let specifiers = [| "G"; "C"; "D4"; "E2"; "F"; "N"; "P"; "X2" |]
let value = 22042us
for specifier in specifiers do
for culture in cultures do
printfn $"{specifier,2} format using {culture.Name} culture: {value.ToString(specifier, culture), 16}"
printfn ""
// The example displays the following output:
// G format using en-US culture: 22042
// G format using fr-FR culture: 22042
// G format using es-ES culture: 22042
//
// C format using en-US culture: $22,042.00
// C format using fr-FR culture: 22 042,00 €
// C format using es-ES culture: 22.042,00 €
//
// D4 format using en-US culture: 22042
// D4 format using fr-FR culture: 22042
// D4 format using es-ES culture: 22042
//
// E2 format using en-US culture: 2.20E+004
// E2 format using fr-FR culture: 2,20E+004
// E2 format using es-ES culture: 2,20E+004
//
// F format using en-US culture: 22042.00
// F format using fr-FR culture: 22042,00
// F format using es-ES culture: 22042,00
//
// N format using en-US culture: 22,042.00
// N format using fr-FR culture: 22 042,00
// N format using es-ES culture: 22.042,00
//
// P format using en-US culture: 2,204,200.00 %
// P format using fr-FR culture: 2 204 200,00 %
// P format using es-ES culture: 2.204.200,00 %
//
// X2 format using en-US culture: 561A
// X2 format using fr-FR culture: 561A
// X2 format using es-ES culture: 561A
Imports System.Globalization
Module Example
Public Sub Main()
' Define cultures whose formatting conventions are to be used.
Dim cultures() As CultureInfo = {CultureInfo.CreateSpecificCulture("en-US"), _
CultureInfo.CreateSpecificCulture("fr-FR"), _
CultureInfo.CreateSpecificCulture("es-ES") }
Dim specifiers() As String = {"G", "C", "D4", "E2", "F", "N", "P", "X2"}
Dim value As UShort = 22042
For Each specifier As String In specifiers
For Each culture As CultureInfo In Cultures
Console.WriteLine("{0,2} format using {1} culture: {2, 16}", _
specifier, culture.Name, _
value.ToString(specifier, culture))
Next
Console.WriteLine()
Next
End Sub
End Module
' The example displays the following output:
' G format using en-US culture: 22042
' G format using fr-FR culture: 22042
' G format using es-ES culture: 22042
'
' C format using en-US culture: $22,042.00
' C format using fr-FR culture: 22 042,00 €
' C format using es-ES culture: 22.042,00 €
'
' D4 format using en-US culture: 22042
' D4 format using fr-FR culture: 22042
' D4 format using es-ES culture: 22042
'
' E2 format using en-US culture: 2.20E+004
' E2 format using fr-FR culture: 2,20E+004
' E2 format using es-ES culture: 2,20E+004
'
' F format using en-US culture: 22042.00
' F format using fr-FR culture: 22042,00
' F format using es-ES culture: 22042,00
'
' N format using en-US culture: 22,042.00
' N format using fr-FR culture: 22 042,00
' N format using es-ES culture: 22.042,00
'
' P format using en-US culture: 2,204,200.00 %
' P format using fr-FR culture: 2 204 200,00 %
' P format using es-ES culture: 2.204.200,00 %
'
' X2 format using en-US culture: 561A
' X2 format using fr-FR culture: 561A
' X2 format using es-ES culture: 561A
Remarks
The ToString(String, IFormatProvider) method formats a UInt16 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 any valid Standard Numeric Format Strings, or any combination of Custom Numeric Format Strings. If format
is equal to String.Empty or is null
, the return value of the current UInt16 object is formatted with the general format specifier ("G"). If format
is any other value, the method throws a FormatException.
.NET 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.
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 returned by this method. When the ToString(String, IFormatProvider) method is invoked, it calls the provider
parameter's IFormatProvider.GetFormat method and passes it a Type object that represents the NumberFormatInfo type. The GetFormat method then returns the NumberFormatInfo object that provides information for formatting the current UInt16 value, such as the group separator symbol or the decimal point symbol. There are three ways to use the provider
parameter to supply formatting information to the ToString(String, IFormatProvider) method:
You can pass a CultureInfo object that represents the culture that supplies formatting information. Its GetFormat method returns the NumberFormatInfo object that provides numeric formatting information for that culture.
You can pass the actual NumberFormatInfo object that provides numeric formatting information. (Its implementation of GetFormat just returns itself.)
You can pass a custom object that implements IFormatProvider. Its GetFormat method instantiates and returns the NumberFormatInfo object that provides formatting information.
If provider
is null
, the formatting of the returned string is based on the NumberFormatInfo object of the current culture.
See also
- Parse(String)
- Formatting Types in .NET
- How to: Pad a Number with Leading Zeros
- Sample: .NET Core WinForms Formatting Utility (C#)
- Sample: .NET Core WinForms Formatting Utility (Visual Basic)
Applies to
ToString()
- Source:
- UInt16.cs
- Source:
- UInt16.cs
- Source:
- UInt16.cs
Converts the numeric value of this instance to its equivalent string representation.
public:
override System::String ^ ToString();
public override string ToString ();
override this.ToString : unit -> string
Public Overrides Function ToString () As String
Returns
The string representation of the value of this instance, which consists of a sequence of digits ranging from 0 to 9, without a sign or leading zeros.
Examples
The following example displays a UInt16 value by using the default ToString() method. It also displays the string representations of the UInt16 value that results from using some standard format specifiers. The examples are displayed using the formatting conventions of the en-US culture.
using System;
public class Example
{
public static void Main()
{
ushort value = 16324;
// Display value using default ToString method.
Console.WriteLine(value.ToString());
Console.WriteLine();
// Define an array of format specifiers.
string[] formats = { "G", "C", "D", "F", "N", "X" };
// Display value using the standard format specifiers.
foreach (string format in formats)
Console.WriteLine("{0} format specifier: {1,12}",
format, value.ToString(format));
}
}
// The example displays the following output:
// 16324
//
// G format specifier: 16324
// C format specifier: $16,324.00
// D format specifier: 16324
// F format specifier: 16324.00
// N format specifier: 16,324.00
// X format specifier: 3FC4
let value = 16324us
// Display value using default ToString method.
printfn $"{value.ToString()}\n"
// Define an array of format specifiers.
let formats = [| "G"; "C"; "D"; "F"; "N"; "X" |]
// Display value using the standard format specifiers.
for format in formats do
printfn $"{format} format specifier: {value.ToString format,12}"
// The example displays the following output:
// 16324
//
// G format specifier: 16324
// C format specifier: $16,324.00
// D format specifier: 16324
// F format specifier: 16324.00
// N format specifier: 16,324.00
// X format specifier: 3FC4
Module Example
Public Sub Main()
Dim value As UInt16 = 16324
' Display value using default ToString method.
Console.WriteLine(value.ToString())
Console.WriteLine()
' Define an array of format specifiers.
Dim formats() As String = { "G", "C", "D", "F", "N", "X" }
' Display value using the standard format specifiers.
For Each format As String In formats
Console.WriteLine("{0} format specifier: {1,12}", _
format, value.ToString(format))
Next
End Sub
End Module
' The example displays the following output:
' 16324
'
' G format specifier: 16324
' C format specifier: $16,324.00
' D format specifier: 16324
' F format specifier: 16324.00
' N format specifier: 16,324.00
' X format specifier: 3FC4
Remarks
The ToString() method formats a UInt16 value in the default ("G", or general) format by using the NumberFormatInfo object of the current culture. If you want to specify a different format or culture, use the other overloads of the ToString method, as follows:
To use format | For culture | Use the overload |
---|---|---|
Default ("G") format | A specific culture | ToString(IFormatProvider) |
A specific format | Default (current) culture | ToString(String) |
A specific format | A specific culture | ToString(String, IFormatProvider) |