Export (0) Print
Expand All

NumberFormatInfo.NumberNegativePattern Property

Gets or sets the format pattern for negative numeric values.

[Visual Basic]
Public Property NumberNegativePattern As Integer
[C#]
public int NumberNegativePattern {get; set;}
[C++]
public: __property int get_NumberNegativePattern();
public: __property void set_NumberNegativePattern(int);
[JScript]
public function get NumberNegativePattern() : int;
public function set NumberNegativePattern(int);

Property Value

The format pattern for negative numeric values. The default for InvariantInfo is 1, which represents "-n", where n is a number.

Exceptions

Exception Type Condition
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 is read-only.

Remarks

This property can have 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 -

Example

The following code example prints a value using different NumberNegativePattern patterns.

[Visual Basic] 
Imports System
Imports System.Globalization
Imports Microsoft.VisualBasic

Class SamplesNumberFormatInfo    
    
    Public Shared Sub Main()
        
        ' Creates a new NumberFormatinfo.
        Dim myNfi As New NumberFormatInfo()
        
        ' Takes a negative value.
        Dim myInt As Int64 = - 1234
        
        ' Displays the value with default formatting.
        Console.WriteLine("Default  " + ControlChars.Tab + ":" _
           + ControlChars.Tab + "{0}", myInt.ToString("N", myNfi))
        
        ' Displays the value with other patterns.
        Dim i As Integer
        For i = 0 To 4
            myNfi.NumberNegativePattern = i
            Console.WriteLine("Pattern {0}" + ControlChars.Tab + ":" _
               + ControlChars.Tab + "{1}", myNfi.NumberNegativePattern, _
               myInt.ToString("N", myNfi))
        Next i
    End Sub
End Class

' This code produces 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 -

[C#] 
using System;
using System.Globalization;
class SamplesNumberFormatInfo  {

   public static void Main()  {

      // Creates a new NumberFormatinfo.
      NumberFormatInfo myNfi = new NumberFormatInfo();

      // Takes a negative value.
      Int64 myInt = -1234;

      // Displays the value with default formatting.
      Console.WriteLine( "Default  \t:\t{0}", myInt.ToString( "N", myNfi ) );

      // Displays the value with other patterns.
      for ( int i = 0; i <= 4; i++ )  {
         myNfi.NumberNegativePattern = i;
         Console.WriteLine( "Pattern {0}\t:\t{1}", myNfi.NumberNegativePattern, myInt.ToString( "N", myNfi ) );
      }
   }
}
/*
This code produces 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 -
*/

[C++] 
#using <mscorlib.dll>
using namespace System;
using namespace System::Globalization;

int main()
{
   // Creates a new NumberFormatinfo.
   NumberFormatInfo* myNfi = new NumberFormatInfo();

   // Takes a negative value.
   Int64 myInt = -1234;

   // Displays the value with default formatting.
   Console::WriteLine(S"Default  \t:\t {0}", myInt.ToString(S"N", myNfi));

   // Displays the value with other patterns.
   for (int i = 0; i <= 4; i++)
   {
      myNfi -> NumberNegativePattern = i;
      Console::WriteLine(S"Pattern {0}\t:\t {1}", 
          __box(myNfi -> NumberNegativePattern), 
          myInt.ToString(S"N", myNfi)
          );
   }
}
/*
This code produces 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 -
*/

[JScript] 
import System
import System.Globalization

// Creates a new NumberFormatinfo.
var myNfi : NumberFormatInfo = new NumberFormatInfo()

// Takes a negative value.
var myInt : Int64 = - 1234

// Displays the value with default formatting.
Console.WriteLine("Default  \t:\t{0}", myInt.ToString("N", myNfi))

// Displays the value with other patterns.
for(var i = 0; i < 5; i++){
    myNfi.NumberNegativePattern = i
    Console.WriteLine("Pattern {0}\t:\t{1}", myNfi.NumberNegativePattern, myInt.ToString("N", myNfi))
}

// This code produces 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 -

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework, Common Language Infrastructure (CLI) Standard

See Also

NumberFormatInfo Class | NumberFormatInfo Members | System.Globalization Namespace | NumberDecimalDigits | NumberDecimalSeparator | NumberGroupSeparator | NumberGroupSizes | NaNSymbol | CurrencyNegativePattern | PercentNegativePattern

Show:
© 2014 Microsoft