NumberFormatInfo.CurrencyNegativePattern Property
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.
Gets or sets the format pattern for negative currency values.
public:
property int CurrencyNegativePattern { int get(); void set(int value); };public int CurrencyNegativePattern { get; set; }member this.CurrencyNegativePattern : int with get, setPublic Property CurrencyNegativePattern As IntegerProperty Value
The format pattern for negative currency values. The default for InvariantInfo is 0, which represents "(\$n)", where "\$" is the CurrencySymbol and n is a number.
Exceptions
The property is set to a value that's less than 0 or greater than 16. On .NET Core 3.1 and earlier versions, this exception is thrown if the value is greater than 15.
The property is being set and the NumberFormatInfo object is read-only.
Examples
The following example shows how the CurrencyNegativePattern property defines the format of negative currency values. It retrieves all the specific cultures that are defined on the host computer and displays each culture's CurrencyNegativePattern property value, its associated pattern, and a number formatted as a currency value.
using System;
using System.Collections.Generic;
using System.Globalization;
public class Example : IComparer<CultureInfo>
{
public static void Main()
{
// Assign possible values and their associated patterns to a
// generic Dictionary object.
Dictionary<int, String> patterns = new Dictionary<int, String>();
string[] patternStrings= { "($n)", "-$n", "$-n", "$n-", "(n$)",
"-n$", "n-$", "n$-", "-n $", "-$ n",
"n $-", "$ n-", "$ -n", "n- $", "($ n)",
"(n $)", "$- n" };
for (int ctr = patternStrings.GetLowerBound(0);
ctr <= patternStrings.GetUpperBound(0); ctr++)
patterns.Add(ctr, patternStrings[ctr]);
// Retrieve all specific cultures.
CultureInfo[] cultures = CultureInfo.GetCultures(CultureTypes.SpecificCultures);
Array.Sort(cultures, new Example());
double number = -16.335;
// Display the culture, CurrencyNegativePattern value, associated pattern, and result.
foreach (var culture in cultures)
Console.WriteLine("{0,-15} {1,2} ({2,5}) {3,15}", culture.Name + ":",
culture.NumberFormat.CurrencyNegativePattern,
patterns[culture.NumberFormat.CurrencyNegativePattern],
number.ToString("C", culture));
}
public int Compare(CultureInfo x, CultureInfo y)
{
return String.Compare(x.Name, y.Name);
}
}
// A portion of the output appears as follows:
// ca-ES: 8 ( -n $) -16,34 €
// co-FR: 8 ( -n $) -16,34 €
// cs-CZ: 8 ( -n $) -16,34 Kč
// cy-GB: 1 ( -$n) -£16.34
// da-DK: 12 ( $ -n) kr. -16,34
// de-AT: 9 ( -$ n) -€ 16,34
// de-CH: 2 ( $-n) Fr.-16.34
// de-DE: 8 ( -n $) -16,34 €
// de-LI: 2 ( $-n) CHF-16.34
// de-LU: 8 ( -n $) -16,34 €
// dsb-DE: 8 ( -n $) -16,34 €
// luy-KE: 16 ( $- n) Ksh- 16.34
//
// The result shown here happens only if using ICU.
// Apps that use NLS, for example, .NET Framework apps, might see different results.
// Globalization data can change, which would also change these results.
Imports System.Collections.Generic
Imports System.Globalization
Public Class Example : Implements IComparer(Of CultureInfo)
Public Shared Sub Main()
' Assign possible values and their associated patterns to a
' generic Dictionary object.
Dim patterns As New Dictionary(Of Integer, String)
Dim patternStrings() As String = { "($n)", "-$n", "$-n", "$n-", "(n$)",
"-n$", "n-$", "n$-", "-n $", "-$ n",
"n $-", "$ n-", "$ -n", "n- $", "($ n)",
"(n $)", "$- n" }
For ctr As Integer = patternStrings.GetLowerBound(0) To patternStrings.GetUpperBound(0)
patterns.Add(ctr, patternStrings(ctr))
Next
' Retrieve all specific cultures.
Dim cultures() As CultureInfo = CultureInfo.GetCultures(CultureTypes.SpecificCultures)
Array.Sort(cultures, New Example())
Dim number As Double = -16.335
' Display the culture, CurrencyNegativePattern value, associated pattern, and result.
For Each culture In cultures
Console.WriteLine("{0,-15} {1,2} ({2,5}) {3,15}", culture.Name + ":",
culture.NumberFormat.CurrencyNegativePattern,
patterns.Item(culture.NumberFormat.CurrencyNegativePattern),
number.ToString("C", culture))
Next
End Sub
Public Function Compare(x As CultureInfo, y As CultureInfo) As Integer _
Implements IComparer(Of CultureInfo).Compare
Return String.Compare(x.Name, y.Name)
End Function
End Class
' A portion of the output appears as follows:
' ca-ES: 8 ( -n $) -16,34 €
' co-FR: 8 ( -n $) -16,34 €
' cs-CZ: 8 ( -n $) -16,34 Kč
' cy-GB: 1 ( -$n) -£16.34
' da-DK: 12 ( $ -n) kr. -16,34
' de-AT: 9 ( -$ n) -€ 16,34
' de-CH: 2 ( $-n) Fr.-16.34
' de-DE: 8 ( -n $) -16,34 €
' de-LI: 2 ( $-n) CHF-16.34
' de-LU: 8 ( -n $) -16,34 €
' dsb-DE: 8 ( -n $) -16,34 €
' luy-KE: 16 ( $- n) Ksh- 16.34
'
' The result shown here happens only if using ICU.
' Apps that use NLS, for example, .NET Framework apps, might see different results.
' Globalization data can change, which would also change these results.
Remarks
The CurrencyNegativePattern property is used with the "C" standard format string to define the pattern of negative currency values. For more information, see Standard Numeric Format Strings. This property has one of the values in the following table. The symbol "$" is the CurrencySymbol, the symbol "-" is the NegativeSign, and n is a number.
| Value | Associated pattern |
|---|---|
| 0 | ($n) |
| 1 | -$n |
| 2 | $-n |
| 3 | $n- |
| 4 | (n$) |
| 5 | -n$ |
| 6 | n-$ |
| 7 | n$- |
| 8 | -n $ |
| 9 | -$ n |
| 10 | n $- |
| 11 | $ n- |
| 12 | $ -n |
| 13 | n- $ |
| 14 | ($ n) |
| 15 | (n $) |
| 16 | $- n |
