Edit

Share via

NumberFormatInfo.NumberNegativePattern Property

  • Reference

Definition

Namespace:
System.Globalization
Assembly:
System.Globalization.dll
Assembly:
System.Runtime.dll
Assembly:
mscorlib.dll
Assembly:
netstandard.dll
Source:
NumberFormatInfo.cs
Source:
NumberFormatInfo.cs
Source:
NumberFormatInfo.cs

Gets or sets the format pattern for negative numeric values.

public:
 property int NumberNegativePattern { int get(); void set(int value); };
public int NumberNegativePattern { get; set; }
member this.NumberNegativePattern : int with get, set
Public Property NumberNegativePattern As Integer

Property Value

Int32

The format pattern for negative numeric values.

Exceptions

ArgumentOutOfRangeException

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

InvalidOperationException

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

Examples

The following example displays a value using different NumberNegativePattern patterns.

using namespace System;
using namespace System::Globalization;

int main()
{
   // Create a new NumberFormatinfo.
   NumberFormatInfo^ nfi = gcnew NumberFormatInfo;
   
   // Takes a negative value.
   Int64 value = -1234;
   
   // Displays the value with default formatting.
   Console::WriteLine("{0,-20} {1,-10}", "Default:", 
                          value.ToString("N", nfi));
   
   // Displays 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 -

 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 -

Imports System.Globalization

Module Example
    Public Sub Main()
        ' Creates a new NumberFormatinfo.
        Dim nfi As New NumberFormatInfo()
        
        ' Define a negative value.
        Dim value As Int64 = -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 i As Integer = 0 To 4
            nfi.NumberNegativePattern = i
            Console.WriteLine("{0,-20} {1,-10}", 
                              String.Format("Pattern {0}:", 
                                            nfi.NumberNegativePattern), 
                              value.ToString("N", nfi))
        Next 
    End Sub
End Module
' 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

See also