CurrencyFormatInfo Class

Definition

Namespace: DataStandardizer.Money

Defines how monetary values are formatted and parsed for a culture.

public sealed class CurrencyFormatInfo : IFormatProvider

Remarks

This type is the monetary counterpart of NumberFormatInfo, but it deliberately omits a currency symbol. A Money value carries its own currency, so the symbol, the currency code and the default precision are all determined by the value being formatted rather than by the culture formatting it. The culture governs presentation only.

CurrencyCode is the exception, and exists for parsing rather than formatting: it is what allows a currency symbol shared by several currencies, such as $, to be resolved to a specific currency using the context of a culture.

The values for a culture come from the Unicode Common Locale Data Repository (CLDR) data built into the package, and depend only on the culture’s name, never on the culture data of the operating system, so they are the same on every host and target.

  • Language codes: a deprecated or legacy language code is replaced first, as CLDR’s language aliases say, so iw is read as he and tl as fil.
  • Presentation (separators, group sizes, the two patterns and the negative sign) comes from the CLDR locale the name resolves to under CLDR inheritance. So de-AT has its own Austrian layout, and a culture such as pt-FR takes that of its CLDR parent, pt-PT. CLDR’s Latin digits and currency separators are used. A culture that CLDR resolves to its root locale, or that it doesn’t know, keeps the invariant presentation.
  • CurrencyCode is the current currency CLDR gives the culture’s region, as EUR for de-AT. A neutral culture such as de names no region, so it has no currency (XXX).
  • CurrencyDecimalDigits is the number of ISO 4217 minor units of that currency, or 2 where there is none.

The data covers the locales CLDR rates at modern coverage. CLDR’s minimum grouping digits and currency spacing aren’t represented, so the presentation is the one decimal gives the same NumberFormatInfo values.

When parsing, a hyphen-minus is also read as the negative sign where the sign is a single dash such as U+2212 MINUS SIGN (Swedish, Finnish and others), as decimal reads it.

Properties

Property Type Notes
CurrencyCode string ISO 4217 code of the culture’s own currency. Used when parsing a shared symbol. Exactly the three upper-case letters of an Iso4217CurrencyCurrent member.
CurrencyDecimalDigits int The culture’s default precision. Lowest priority when formatting. 0 to 99.
CurrencyDecimalSeparator string Separates the integral and fractional parts. Not empty.
CurrencyGroupSeparator string Separates groups of digits. May be empty.
CurrencyGroupSizes int[] Sizes of the digit groups; { 3, 2 } for the Indian numbering system.
CurrencyNegativePattern int Placement pattern for negative values, using the NumberFormatInfo indices 0 to 16.
CurrencyPositivePattern int Placement pattern for positive values, using the NumberFormatInfo indices 0 to 3.
NegativeSign string The sign denoting a negative value; not always an ASCII hyphen. May be empty.
IsReadOnly bool true when the instance may not be modified.

Each setter other than CurrencyCode accepts what the NumberFormatInfo property of the same name accepts, and throws the same exception for anything else: ArgumentNullException for null, ArgumentOutOfRangeException for a number out of range, and ArgumentException for an empty decimal separator or invalid group sizes. NumberFormatInfo has no CurrencyCode. This setter throws ArgumentNullException for null and ArgumentException for anything that isn’t a code Iso4217CurrencyCurrent defines. Setting any property on a read-only instance raises an InvalidOperationException. As in NumberFormatInfo, the setters for the numbers, CurrencyCode, CurrencyGroupSizes and NegativeSign check the value first, and the separator setters check whether the instance is read-only first.

Static properties

Property Type Notes
CurrentInfo CurrencyFormatInfo Read-only information for the current culture; tracks a change of culture.
InvariantInfo CurrencyFormatInfo Read-only culture-independent information.

Methods

Method Returns Notes
GetFormat(Type) object? Returns the instance itself when CurrencyFormatInfo is requested.

Applies to

Targets netstandard1.1, netstandard2.0, and net10.0.

CurrentInfo requires netstandard2.0 or later, because the current culture is unavailable on netstandard1.1.

See also


This site uses Just the Docs, a documentation theme for Jekyll.