Custom Numeric Format Strings
Microsoft Silverlight will reach end of support after October 2021. Learn more.
You can create a custom numeric format string, which consists of one or more custom numeric specifiers, to define how to format numeric data. A custom numeric format string is any format string that is not a standard numeric format string.
Custom numeric format strings are supported by some overloads of the ToString method of all numeric types. For example, you can supply a numeric format string to the ToString(String) and ToString(String, IFormatProvider) methods of the Int32 type. Custom numeric format strings are also supported by the .NET Framework composite formatting feature, which is used by some Write and WriteLine methods of the Console and StreamWriter classes, the String.Format method, and the StringBuilder.AppendFormat method.
The following table describes the custom numeric format specifiers and displays sample output produced by each format specifier. See the Notes section for additional information about using custom numeric format strings, and the Example section for a comprehensive illustration of their use.
Format specifier |
Name |
Description |
Examples |
|---|---|---|---|
"0" |
Zero placeholder |
Replaces the zero with the corresponding digit if one is present; otherwise, zero appears in the result string. More information: The "0" Custom Specifier. |
1234.5678 ("00000") -> 01235 0.45678 ("0.00", en-US) -> 0.46 0.45678 ("0.00", fr-FR) -> 0,46 |
"#" |
Digit placeholder |
Replaces the pound sign with the corresponding digit if one is present; otherwise, no digit appears in the result string. More information: The "#" Custom Specifier. |
1234.5678 ("#####") -> 1235 0.45678 ("#.##", en-US) -> .46 0.45678 ("#.##", fr-FR) -> ,46 |
"." |
Decimal point |
Determines the location of the decimal separator in the result string. More information: The "." Custom Specifier. |
0.45678 ("0.00", en-US) -> 0.46 0.45678 ("0.00", fr-FR) -> 0,46 |
"," |
Group separator and number scaling |
Serves as both a group separator and a number scaling specifier. As a group separator, it inserts a localized group separator character between each group. As a number scaling specifier, it divides a number by 1000 for each comma specified. More information: The "," Custom Specifier. |
Group separator specifier: 2147483647 ("##,#", en-US) -> 2,147,483,647 2147483647 ("##,#", es-ES) -> 2.147.483.647 Scaling specifier: 2147483647 ("#,#,,", en-US) -> 2,147 2147483647 ("#,#,,", es-ES) -> 2.147 |
"%" |
Percentage placeholder |
Multiplies a number by 100 and inserts a localized percentage symbol in the result string. More information: The "%" Custom Specifier. |
0.3697 ("%#0.00", en-US) -> %36.97 0.3697 ("%#0.00", el-GR) -> %36,97 0.3697 ("##.0 %", en-US) -> 37.0 % 0.3697 ("##.0 %", el-GR) -> 37,0 % |
"‰" |
Per mille placeholder |
Multiplies a number by 1000 and inserts a localized per mille symbol in the result string. More information: The "‰" Custom Specifier. |
0.03697 ("#0.00‰", en-US) -> 36.97‰ 0.03697 ("#0.00‰", ru-RU) -> 36,97‰ |
"E0" "E+0" "E-0" "e0" "e+0" "e-0" |
Exponential notation |
If followed by at least one 0 (zero), formats the result using exponential notation. The case of "E" or "e" indicates the case of the exponent symbol in the result string. The number of zeros following the "E" or "e" character determines the minimum number of digits in the exponent. A plus sign (+) indicates that a sign character always precedes the exponent. A minus sign (-) indicates that a sign character precedes only negative exponents. More information: The "E" and "e" Custom Specifiers. |
987654 ("#0.0e0") -> 98.8e4 1503.92311 ("0.0##e+00") -> 1.504e+03 1.8901385E-16 ("0.0e+00") -> 1.9e-16 |
\ |
Escape character |
Causes the next character to be interpreted as a literal rather than as a custom format specifier. More information: The "\" Escape Character. |
987654 ("\###00\#") -> #987654# |
'string' "string" |
Literal string delimiter |
Indicates that the enclosed characters should be copied to the result string unchanged. |
68 ("# ' degrees'") -> 68 degrees 68 ("#' degrees'") -> 68 degrees |
; |
Section separator |
Defines sections with separate format strings for positive, negative, and zero numbers. More information: The ";" Section Separator. |
12.345 ("#0.0#;(#0.0#);-\0-") -> 12.35 0 ("#0.0#;(#0.0#);-\0-") -> -0- -12.345 ("#0.0#;(#0.0#);-\0-") -> (12.35) 12.345 ("#0.0#;(#0.0#)") -> 12.35 0 ("#0.0#;(#0.0#)") -> 0.0 -12.345 ("#0.0#;(#0.0#)") -> (12.35) |
Other |
All other characters |
The character is copied to the result string unchanged. |
68 ("# °") -> 68 ° |
The following sections provide detailed information about each of the custom numeric format specifiers.
The "0" Custom Specifier
The "0" custom format specifier serves as a zero-placeholder symbol. If the value that is being formatted has a digit in the position where the zero appears in the format string, that digit is copied to the result string; otherwise, a zero appears in the result string. The position of the leftmost zero before the decimal point and the rightmost zero after the decimal point determines the range of digits that are always present in the result string.
The "00" specifier causes the value to be rounded to the nearest digit preceding the decimal, where rounding away from zero is always used. For example, formatting 34.5 with "00" would result in the value 35.
The following example displays several values that are formatted by using custom format strings that include zero placeholders.
Dim value As Double
value = 123
outputBlock.Text &= value.ToString("00000") & vbCrLf
' Displays 00123
value = 1.2
outputBlock.Text &= String.Format(value.ToString("0.00", CultureInfo.InvariantCulture)) & vbCrLf
' Displays 1.20
outputBlock.Text &= String.Format(value.ToString("00.00", CultureInfo.InvariantCulture)) & vbCrLf
' Displays 01.20
outputBlock.Text &= value.ToString("00.00", New CultureInfo("da-DK")) & vbCrLf
' Displays 01,20
value = 0.56
outputBlock.Text &= String.Format(value.ToString("0.0", CultureInfo.InvariantCulture)) & vbCrLf
' Displays 0.6
value = 1234567890
outputBlock.Text += value.ToString("0,0", CultureInfo.InvariantCulture)
' Displays 1,234,567,890
outputBlock.Text += value.ToString("0,0", New CultureInfo("el-GR"))
' Displays 1.234.567.890
value = 1234567890.123456
outputBlock.Text += value.ToString("0,0.0", CultureInfo.InvariantCulture)
' Displays 1,234,567,890.1
value = 1234.567890
outputBlock.Text += value.ToString("0,0.00", CultureInfo.InvariantCulture)
' Displays 1,234.57
double value;
value = 123;
outputBlock.Text += value.ToString("00000") + "\n";
// Displays 00123
value = 1.2;
outputBlock.Text += String.Format(value.ToString("0.00", CultureInfo.InvariantCulture)) + "\n";
// Displays 1.20
outputBlock.Text += String.Format(value.ToString("00.00", CultureInfo.InvariantCulture)) + "\n";
// Displays 01.20
outputBlock.Text += value.ToString("00.00", new CultureInfo("da-DK")) +
"\n";
// Displays 01,20
value = .56;
outputBlock.Text += String.Format(value.ToString("0.0", CultureInfo.InvariantCulture)) + "\n";
// Displays 0.6
value = 1234567890;
outputBlock.Text += value.ToString("0,0", CultureInfo.InvariantCulture);
// Displays 1,234,567,890
outputBlock.Text += value.ToString("0,0", new CultureInfo("el-GR"));
// Displays 1.234.567.890
value = 1234567890.123456;
outputBlock.Text += value.ToString("0,0.0", CultureInfo.InvariantCulture);
// Displays 1,234,567,890.1
value = 1234.567890;
outputBlock.Text += value.ToString("0,0.00", CultureInfo.InvariantCulture);
// Displays 1,234.57
Back to table
The "#" Custom Specifier
The "#" custom format specifier serves as a digit-placeholder symbol. If the value that is being formatted has a digit in the position where the pound sign appears in the format string, that digit is copied to the result string. Otherwise, nothing is stored in that position in the result string.
Note that this specifier never displays a zero that is not a significant digit, even if zero is the only digit in the string. It will display zero only if it is a significant digit in the number that is being displayed.
The "##" format string causes the value to be rounded to the nearest digit preceding the decimal, where rounding away from zero is always used. For example, formatting 34.5 with "##" would result in the value 35.
The following example displays several values that are formatted by using custom format strings that include digit placeholders.
Dim value As Double
value = 1.2
outputBlock.Text &= String.Format(value.ToString("#.##", CultureInfo.InvariantCulture)) & vbCrLf
' Displays 1.2
value = 123
outputBlock.Text &= value.ToString("#####") & vbCrLf
' Displays 123
value = 123456
outputBlock.Text &= value.ToString("[##-##-##]") & vbCrLf
' Displays [12-34-56]
value = 1234567890
outputBlock.Text &= value.ToString("#") & vbCrLf
' Displays 1234567890
outputBlock.Text &= value.ToString("(###) ###-####") & vbCrLf
' Displays (123) 456-7890
double value;
value = 1.2;
outputBlock.Text += String.Format(value.ToString("#.##", CultureInfo.InvariantCulture)) + "\n";
// Displays 1.2
value = 123;
outputBlock.Text += value.ToString("#####") + "\n";
// Displays 123
value = 123456;
outputBlock.Text += value.ToString("[##-##-##]") + "\n";
// Displays [12-34-56]
value = 1234567890;
outputBlock.Text += value.ToString("#") + "\n";
// Displays 1234567890
outputBlock.Text += value.ToString("(###) ###-####") + "\n";
// Displays (123) 456-7890
Back to table
The "." Custom Specifier
The "." custom format specifier inserts a localized decimal separator into the result string. The first period in the format string determines the location of the decimal separator in the formatted value; any additional periods are ignored.
The character that is used as the decimal separator in the result string is not always a period; it is determined by the NumberDecimalSeparator property of the NumberFormatInfo object that controls formatting.
The following example uses the "." format specifier to define the location of the decimal point in several result strings.
Dim value As Double
value = 1.2
outputBlock.Text &= String.Format(value.ToString("0.00", CultureInfo.InvariantCulture)) & vbCrLf
' Displays 1.20
outputBlock.Text &= String.Format(value.ToString("00.00", CultureInfo.InvariantCulture)) & vbCrLf
' Displays 01.20
outputBlock.Text &= value.ToString("00.00", New CultureInfo("da-DK")) + _
vbCrLf
' Displays 01,20
value = 0.086
outputBlock.Text &= String.Format(value.ToString("#0.##%", CultureInfo.InvariantCulture)) & vbCrLf
' Displays 8.6%
value = 86000
outputBlock.Text &= String.Format(value.ToString("0.###E+0", CultureInfo.InvariantCulture)) & vbCrLf
' Displays 8.6E+4
double value;
value = 1.2;
outputBlock.Text += String.Format(value.ToString("0.00", CultureInfo.InvariantCulture)) + "\n";
// Displays 1.20
outputBlock.Text += String.Format(value.ToString("00.00", CultureInfo.InvariantCulture)) + "\n";
// Displays 01.20
outputBlock.Text += value.ToString("00.00", new CultureInfo("da-DK")) +
"\n";
// Displays 01,20
value = .086;
outputBlock.Text += String.Format(value.ToString("#0.##%", CultureInfo.InvariantCulture)) + "\n";
// Displays 8.6%
value = 86000;
outputBlock.Text += String.Format(value.ToString("0.###E+0", CultureInfo.InvariantCulture)) + "\n";
// Displays 8.6E+4
Back to table
The "," Custom Specifier
The "," character serves as both a group separator and a number scaling specifier.
Group separator: If one or more commas are specified between two digit placeholders (0 or #) that format the integral digits of a number, a group separator character is inserted between each number group in the integral part of the output.
The NumberGroupSeparator and NumberGroupSizes properties of the current NumberFormatInfo object determine the character used as the number group separator and the size of each number group. For example, if the string "#,#" and the invariant culture are used to format the number 1000, the output is "1,000".
Number scaling specifier: If one or more commas are specified immediately to the left of the explicit or implicit decimal point, the number to be formatted is divided by 1000 for each comma. For example, if the string "0,," is used to format the number 100 million, the output is "100".
You can use group separator and number scaling specifiers in the same format string. For example, if the string "#,0,," and the invariant culture are used to format the number one billion, the output is "1,000".
The following example illustrates the use of the comma as a group separator.
Dim value As Double = 1234567890
outputBlock.Text &= String.Format(value.ToString("#,#", CultureInfo.InvariantCulture)) & vbCrLf
' Displays 1,234,567,890
outputBlock.Text &= String.Format(value.ToString("#,##0,,", CultureInfo.InvariantCulture)) & vbCrLf
' Displays 1,235
double value = 1234567890;
outputBlock.Text += String.Format(value.ToString("#,#", CultureInfo.InvariantCulture)) + "\n";
// Displays 1,234,567,890
outputBlock.Text += String.Format(value.ToString("#,##0,,", CultureInfo.InvariantCulture)) + "\n";
// Displays 1,235
The following example illustrates the use of the comma as a specifier for number scaling.
Dim value As Double = 1234567890
outputBlock.Text &= String.Format(value.ToString("#,,", CultureInfo.InvariantCulture)) & vbCrLf
' Displays 1235
outputBlock.Text &= String.Format(value.ToString("#,,,", CultureInfo.InvariantCulture)) & vbCrLf
' Displays 1
outputBlock.Text &= String.Format(value.ToString("#,##0,,", CultureInfo.InvariantCulture)) & vbCrLf
' Displays 1,235
double value = 1234567890;
outputBlock.Text += String.Format(value.ToString("#,,", CultureInfo.InvariantCulture)) + "\n";
// Displays 1235
outputBlock.Text += String.Format(value.ToString("#,,,", CultureInfo.InvariantCulture)) + "\n";
// Displays 1
outputBlock.Text += String.Format(value.ToString("#,##0,,", CultureInfo.InvariantCulture)) + "\n";
// Displays 1,235
Back to table
The "%" Custom Specifier
A percent sign (%) in a format string causes a number to be multiplied by 100 before it is formatted. The localized percent symbol is inserted in the number at the location where the % appears in the format string. The percent character used is defined by the PercentSymbol property of the current NumberFormatInfo object.
The following example defines several custom format strings that include the "%" custom specifier.
Dim value As Double = 0.086
outputBlock.Text &= String.Format(value.ToString("#0.##%", CultureInfo.InvariantCulture)) & vbCrLf
' Displays 8.6%
double value = .086;
outputBlock.Text += String.Format(value.ToString("#0.##%", CultureInfo.InvariantCulture)) + "\n";
// Displays 8.6%
Back to table
The "‰" Custom Specifier
A per mille character (‰ or \u2030) in a format string causes a number to be multiplied by 1000 before it is formatted. The appropriate per mille symbol is inserted in the returned string at the location where the ‰ symbol appears in the format string. The per mille character used is defined by the NumberFormatInfo.PerMilleSymbol property of the object that provides culture-specific formatting information.
The following example defines a custom format string that includes the "‰" custom specifier.
Back to table
The "E" and "e" Custom Specifiers
If any of the strings "E", "E+", "E-", "e", "e+", or "e-" are present in the format string and are followed immediately by at least one zero, the number is formatted by using scientific notation with an "E" or "e" inserted between the number and the exponent. The number of zeros following the scientific notation indicator determines the minimum number of digits to output for the exponent. The "E+" and "e+" formats indicate that a plus sign or minus sign should always precede the exponent. The "E", "E-", "e", or "e-" formats indicate that a sign character should precede only negative exponents.
The following example formats several numeric values using the specifiers for scientific notation.
Dim value As Double = 86000
outputBlock.Text &= String.Format(value.ToString("0.###E+0", CultureInfo.InvariantCulture)) & vbCrLf
' Displays 8.6E+4
outputBlock.Text &= String.Format(value.ToString("0.###E+000", CultureInfo.InvariantCulture)) & vbCrLf
' Displays 8.6E+004
outputBlock.Text &= String.Format(value.ToString("0.###E-000", CultureInfo.InvariantCulture)) & vbCrLf
' Displays 8.6E004
double value = 86000;
outputBlock.Text += String.Format(value.ToString("0.###E+0", CultureInfo.InvariantCulture)) + "\n";
// Displays 8.6E+4
outputBlock.Text += String.Format(value.ToString("0.###E+000", CultureInfo.InvariantCulture)) + "\n";
// Displays 8.6E+004
outputBlock.Text += String.Format(value.ToString("0.###E-000", CultureInfo.InvariantCulture)) + "\n";
// Displays 8.6E004
Back to table
The "\" Escape Character
The "#", "0", ".", ",", "%", and "‰" symbols in a format string are interpreted as format specifiers rather than as literal characters. Depending on their position in a custom format string, the uppercase and lowercase "E" may also be interpreted as format specifiers.
To prevent a character from being interpreted as a format specifier, you can precede it with a backslash, which is the escape character. The escape character signifies that the following character is a character literal that should be included in the result string unchanged.
To include a backslash in a result string, you must escape it with another backslash (\\).
.gif "Note") Note: |
|---|
Some compilers, such as the C++ and C# compilers, may also interpret a single backslash character as an escape character. To ensure that a string is interpreted correctly when formatting, you can use the verbatim string literal character (the @ character) before the string in C#, or add another backslash character before each backslash in C# and C++. The following C# example illustrates both approaches. |
The following example uses the escape character to prevent the formatting operation from interpreting the "#", "0", and "\" characters as either escape characters or format specifiers. The C# examples uses an additional backslash to ensure that a backslash is interpreted as a literal character.
Back to table
The ";" Section Separator
The semicolon (;) is a conditional format specifier that applies different formatting to a number depending on whether its value is positive, negative, or zero. To produce this behavior, a custom format string can contain up to three sections separated by semicolons. These sections are described in the following table.
Number of sections |
Description |
|---|---|
One section |
The format string applies to all values. |
Two sections |
The first section applies to positive values and zeros, and the second section applies to negative values. If the number to be formatted is negative, but becomes zero after rounding according to the format in the second section, the resulting zero is formatted according to the first section. |
Three sections |
The first section applies to positive values, the second section applies to negative values, and the third section applies to zeros. The second section can be left empty (by having nothing between the semicolons), in which case the first section applies to all nonzero values. If the number to be formatted is nonzero, but becomes zero after rounding according to the format in the first or second section, the resulting zero is formatted according to the third section. |
Section separators ignore any preexisting formatting associated with a number when the final value is formatted. For example, negative values are always displayed without a minus sign when section separators are used. If you want the final formatted value to have a minus sign, you should explicitly include the minus sign as part of the custom format specifier.
The following example uses the ";" format specifier to format positive, negative, and zero numbers differently.
Dim posValue As Double = 1234
Dim negValue As Double = -1234
Dim fmt As String = "##;(##)"
outputBlock.Text &= posValue.ToString(fmt) & vbCrLf ' Displays 1234
outputBlock.Text &= negValue.ToString(fmt) & vbCrLf ' Displays 1234
double posValue = 1234;
double negValue = -1234;
string fmt = "##;(##)";
outputBlock.Text += posValue.ToString(fmt) + "\n"; // Displays 1234
outputBlock.Text += negValue.ToString(fmt) + "\n"; // Displays (1234)
Back to table
Notes
Floating-Point Infinities and NaN
Regardless of the format string, if the value of a Single or Double floating-point type is positive infinity, negative infinity, or not a number (NaN), the formatted string is the value of the respective PositiveInfinitySymbol, NegativeInfinitySymbol, or NaNSymbol property specified by the currently applicable NumberFormatInfo object.
Control Panel Settings
The settings in the Regional and Language Options item in Control Panel influence the result string produced by a formatting operation. Those settings are used to initialize the NumberFormatInfo object associated with the current thread culture, and the current thread culture provides values used to govern formatting. Computers that use different settings generate different result strings.
Rounding and Fixed-Point Format Strings
For fixed-point format strings (that is, format strings that do not contain scientific notation format characters), numbers are rounded to as many decimal places as there are digit placeholders to the right of the decimal point. If the format string does not contain a decimal point, the number is rounded to the nearest integer. If the number has more digits than there are digit placeholders to the left of the decimal point, the extra digits are copied to the result string immediately before the first digit placeholder.
Example
The following example demonstrates two custom numeric format strings. In both cases, the digit placeholder (#) displays the numeric data, and all other characters are copied to the result string.
See Also