Class NumberFormat
Defines how numeric values are formatted and displayed.
Implements
Namespace: FastReport.Format
Assembly: FastReport.dll
Syntax
public class NumberFormat : FormatBase, IFRSerializable
Constructors
NumberFormat()
Initializes a new instance of the NumberFormat class with default settings.
Declaration
public NumberFormat()
Properties
DecimalDigits
Gets or sets the number of decimal places to use in numeric values.
Declaration
public int DecimalDigits { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 |
DecimalSeparator
Gets or sets the string to use as the decimal separator in numeric values.
Declaration
public string DecimalSeparator { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
GroupSeparator
Gets or sets the string that separates groups of digits to the left of the decimal in numeric values.
Declaration
public string GroupSeparator { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
NegativePattern
Gets or sets the format pattern for negative numeric values.
Declaration
public int NegativePattern { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 |
Remarks
This property can have one of the values in the following table. The symbol n is a number.
| Value | Associated Pattern |
|---|---|
| 0 | (n) |
| 1 | -n |
| 2 | - n |
| 3 | n- |
| 4 | n - |
UseLocale
Gets or sets a value that determines whether to use system locale settings to format a value.
Declaration
public bool UseLocale { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
Methods
Clone()
Creates exact copy of this format.
Declaration
public override FormatBase Clone()
Returns
| Type | Description |
|---|---|
| FormatBase | The copy of this format. |
Overrides
Equals(Object)
Declaration
public override bool Equals(object obj)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | obj |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Overrides
FormatValue(Object)
Formats the specified value.
Declaration
public override string FormatValue(object value)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | value | The value to format. |
Returns
| Type | Description |
|---|---|
| System.String | The string that represents the formatted value. |
Overrides
GetHashCode()
Declaration
public override int GetHashCode()
Returns
| Type | Description |
|---|---|
| System.Int32 |