NumberFormatInfo.NumberNegativePattern Property

Definition

Gets or sets the format pattern for negative numeric values.

C#
public int NumberNegativePattern { get; set; }

Property Value

The format pattern for negative numeric values.

Exceptions

The property is being set to a value that is less than 0 or greater than 4.

The property is being set and the NumberFormatInfo object is read-only.

Examples

The following example displays a value using different NumberNegativePattern patterns.

C#
 using System;
 using System.Globalization;

 class Example
 {
     public static void Main()  {

       // Create a new NumberFormatinfo.
       NumberFormatInfo nfi = new NumberFormatInfo();

       // Define a negative value.
       Int64 value = -1234;

       // Display the value with default formatting.
        Console.WriteLine("{0,-20} {1,-10}", "Default:",
                          value.ToString("N", nfi));

       // Display the value with other patterns.
       for (int i = 0; i <= 4; i++)  {
          nfi.NumberNegativePattern = i;
            Console.WriteLine("{0,-20} {1,-10}",
                              string.Format("Pattern {0}:",
                                            nfi.NumberNegativePattern),
                              value.ToString("N", nfi));
       }
   }
}
// The example displays the following output:
//       Default:             -1,234.00
//       Pattern 0:           (1,234.00)
//       Pattern 1:           -1,234.00
//       Pattern 2:           - 1,234.00
//       Pattern 3:           1,234.00-
//       Pattern 4:           1,234.00 -

Remarks

The NumberNegativePattern property defines the format of negative values formatted with the "N" standard numeric format string. This property has one of the values in the following table. The symbol "-" is the NegativeSign and n is a number.

Value Associated pattern
0 (n)
1 -n
2 - n
3 n-
4 n -

The default value for the invariant culture returned by the InvariantInfo property is 1, which represents "-n", where n is a number.

Applies to

Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1
UWP 10.0

See also