CurrencyFormatter CurrencyFormatter CurrencyFormatter Class

Definition

Formats and parses currencies.

public sealed class CurrencyFormatter : ICurrencyFormatter, ICurrencyFormatter2, INumberFormatter, INumberFormatter2, INumberFormatterOptions, INumberParser, INumberRounderOption, ISignedZeroOption, ISignificantDigitsOptionpublic sealed class CurrencyFormatter : ICurrencyFormatter, ICurrencyFormatter2, INumberFormatter, INumberFormatter2, INumberFormatterOptions, INumberParser, INumberRounderOption, ISignedZeroOption, ISignificantDigitsOptionPublic NotInheritable Class CurrencyFormatter Implements ICurrencyFormatter, ICurrencyFormatter2, INumberFormatter, INumberFormatter2, INumberFormatterOptions, INumberParser, INumberRounderOption, ISignedZeroOption, ISignificantDigitsOption
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

If your app passes language tags used in this class to any National Language Support functions, it must first convert the tags by calling ResolveLocaleName.

Constructors

CurrencyFormatter(String) CurrencyFormatter(String) CurrencyFormatter(String)

Creates a CurrencyFormatter object that is initialized with a currency identifier.

public CurrencyFormatter(String currencyCode)public CurrencyFormatter(String currencyCode)Public Sub New(currencyCode As String)
Parameters
currencyCode
System.String System.String System.String

The currency identifier to use when formatting and parsing currency values.

Attributes

CurrencyFormatter(String, IIterable<String>, String) CurrencyFormatter(String, IIterable<String>, String) CurrencyFormatter(String, IIterable<String>, String)

Creates a CurrencyFormatter object initialized with a currency identifier, language list, and geographic region.

public CurrencyFormatter(String currencyCode, IIterable<String> languages, String geographicRegion)public CurrencyFormatter(String currencyCode, IIterable<String> languages, String geographicRegion)Public Sub New(currencyCode As String, languages As IIterable<String>, geographicRegion As String)
Parameters
currencyCode
System.String System.String System.String

The currency identifier to use when formatting and parsing currency values.

languages

The list of language identifiers, in priority order, representing the choice of languages. See Remarks.

geographicRegion
System.String System.String System.String

The identifier for the geographic region.

Attributes

Remarks

In the case that the symbol for the provided currency is the same symbol as that of a different currency in the provided region (or the home region if none is provided), formatting may use a currency code even if the Mode property is UseSymbol. This is to avoid ambiguity. For example, @Windows.Globalization.NumberFormatting.CurrencyFormatter.#ctor(System.String,Windows.Foundation.Collections.IIterable{System.String},System.String)?text=CurrencyFormatter ("USD", ["en"], "CA") creates a formatter that formats 3 as 3 CAD, even if the Mode property is UseSymbol. Similarly, @Windows.Globalization.NumberFormatting.CurrencyFormatter.#ctor(System.String,Windows.Foundation.Collections.IIterable{System.String},System.String)?text=CurrencyFormatter ("CAD", ["en"], "US") creates a formatter that formats 3 as 3 USD.

If your app passes language tags used in this class to any National Language Support functions, it must first convert the tags by calling ResolveLocaleName.

Starting in : Language tags support the Unicode extensions "ca-" and "nu-". (See Unicode Key/Type Definitions.) Note that the "nu-" extension can affect the numeral system used by CurrencyFormatter objects.

See Also

Properties

Currency Currency Currency

Note

Currency may be read-only for releases after Windows 8.1. Instead, use a new CurrencyFormatter.

Gets the identifier for the currency to be used for formatting and parsing currency values.

public string Currency { get; set; }public string Currency { get; set; }Public ReadWrite Property Currency As string
Value
string string string

The currency identifier to use when formatting and parsing currency values.

Attributes

FractionDigits FractionDigits FractionDigits

Gets or sets the minimum number of digits to display for the fraction part of the currency value.

public int FractionDigits { get; set; }public int FractionDigits { get; set; }Public ReadWrite Property FractionDigits As int
Value
int int int

The minimum number of digits to display.

Attributes

GeographicRegion GeographicRegion GeographicRegion

Gets the region that is used when formatting and parsing currency values.

public string GeographicRegion { get; }public string GeographicRegion { get; }Public ReadOnly Property GeographicRegion As string
Value
string string string

The region that is used.

Attributes

IntegerDigits IntegerDigits IntegerDigits

Gets or sets the minimum number of digits to display for the integer part of the currency value.

public int IntegerDigits { get; set; }public int IntegerDigits { get; set; }Public ReadWrite Property IntegerDigits As int
Value
int int int

The minimum number of digits to display.

Attributes

IsDecimalPointAlwaysDisplayed IsDecimalPointAlwaysDisplayed IsDecimalPointAlwaysDisplayed

Gets or sets whether the decimal point of the currency value should always be displayed.

public bool IsDecimalPointAlwaysDisplayed { get; set; }public bool IsDecimalPointAlwaysDisplayed { get; set; }Public ReadWrite Property IsDecimalPointAlwaysDisplayed As bool
Value
bool bool bool

True if the decimal point of the value should always be displayed, and false otherwise.

Attributes

IsGrouped IsGrouped IsGrouped

Gets or sets whether the integer part of the currency value should be grouped.

public bool IsGrouped { get; set; }public bool IsGrouped { get; set; }Public ReadWrite Property IsGrouped As bool
Value
bool bool bool

True if the integer part of the value should be grouped, and false otherwise.

Attributes

IsZeroSigned IsZeroSigned IsZeroSigned

Gets or sets whether -0 is formatted using the conventions for negative numbers or for positive numbers. (In the Latin numeral system, the choice is "-0" or "0".)

public bool IsZeroSigned { get; set; }public bool IsZeroSigned { get; set; }Public ReadWrite Property IsZeroSigned As bool
Value
bool bool bool

True if -0 is formatted as a negative number, and false if -0 is formatted as a positive number ("-0" or "0" in the Latin numeral system).

Attributes

Remarks

You can set this property to specify that CurrencyFormatter display negative 0 as "-0". This enables the scenario where you wish to display "-0" when it represents the rounded value of some small negative value (such as -0.00001).

This property defaults to false to be consistent with Windows 8 and Windows Server 2012, in which -0 was always formatted as "0".

Languages Languages Languages

Gets the priority list of language identifiers that is used when formatting and parsing currency values.

public IVectorView<string> Languages { get; }public IVectorView<string> Languages { get; }Public ReadOnly Property Languages As IVectorView<string>
Value

The priority list of language identifiers.

Starting in : Language tags can support Unicode extensions. See the Remarks for the @Windows.Globalization.NumberFormatting.CurrencyFormatter.#ctor(System.String,Windows.Foundation.Collections.IIterable{System.String},System.String)?text=CurrencyFormatter(String, IIterable(String), String) constructor.

Attributes

Remarks

If your app passes language tags from this class to any National Language Support functions, it must first convert the tags by calling ResolveLocaleName.

Mode Mode Mode

Gets or sets whether the currency is formatted with the currency symbol or currency code.

public CurrencyFormatterMode Mode { get; set; }public CurrencyFormatterMode Mode { get; set; }Public ReadWrite Property Mode As CurrencyFormatterMode
Value
CurrencyFormatterMode CurrencyFormatterMode CurrencyFormatterMode

The CurrencyFormatterMode value which specifies how the currency is formatted.

Attributes

Remarks

See the remarks for @Windows.Globalization.NumberFormatting.CurrencyFormatter.#ctor(System.String,Windows.Foundation.Collections.IIterable{System.String},System.String)?text=CurrencyFormatter((String, IIterable(String), String)) for an explanation of how the currency code may be displayed when the currency symbol is ambiguous even if the Mode property is UseSymbol.

NumberRounder NumberRounder NumberRounder

Gets or sets the current rounding strategy to be used when formatting currency amounts.

public INumberRounder NumberRounder { get; set; }public INumberRounder NumberRounder { get; set; }Public ReadWrite Property NumberRounder As INumberRounder
Attributes

Remarks

When a Format method is called, the appropriate rounding function from the number rounder object manipulates the input prior to it being formatted.

NumeralSystem NumeralSystem NumeralSystem

Gets or sets the numbering system that is used to format and parse currency values.

public string NumeralSystem { get; set; }public string NumeralSystem { get; set; }Public ReadWrite Property NumeralSystem As string
Value
string string string

A string that indicates the numeral system of the formatter, such as "Latn" for the Latin numeral system (0123456789) or "Arab" for the Arabic-Indic numeral system (٠١٢٣٤٥٦٧٨٩). See the supported NumeralSystem values.

Attributes
See Also

ResolvedGeographicRegion ResolvedGeographicRegion ResolvedGeographicRegion

Gets the geographic region that was most recently used to format or parse currency values.

public string ResolvedGeographicRegion { get; }public string ResolvedGeographicRegion { get; }Public ReadOnly Property ResolvedGeographicRegion As string
Value
string string string

The geographic region that was most recently used to format or parse currency values.

Attributes

ResolvedLanguage ResolvedLanguage ResolvedLanguage

Gets the language that was most recently used to format or parse currency values.

public string ResolvedLanguage { get; }public string ResolvedLanguage { get; }Public ReadOnly Property ResolvedLanguage As string
Value
string string string

The language from the priority list of language identifiers that was most recently used to format or parse currency values.

Starting in : Language tags can support Unicode extensions. See the Remarks for the @Windows.Globalization.NumberFormatting.CurrencyFormatter.#ctor(System.String,Windows.Foundation.Collections.IIterable{System.String},System.String)?text=CurrencyFormatter(String, IIterable(String), String) constructor.

Attributes

Remarks

If your app passes language tags from this class to any National Language Support functions, it must first convert the tags by calling ResolveLocaleName.

SignificantDigits SignificantDigits SignificantDigits

Gets or sets the current padding to significant digits when a currency amount is formatted.

public int SignificantDigits { get; set; }public int SignificantDigits { get; set; }Public ReadWrite Property SignificantDigits As int
Value
int int int

The number of significant digits.

Attributes

Remarks

Trailing zeros are added to the format until the given number of significant digits is exhausted. If there are more digits, this property does not cause them to be truncated.

Methods

ApplyRoundingForCurrency(RoundingAlgorithm) ApplyRoundingForCurrency(RoundingAlgorithm) ApplyRoundingForCurrency(RoundingAlgorithm)

Prepares the CurrencyFormatter object to format currency values with a specified rounding algorithm.

public void ApplyRoundingForCurrency(RoundingAlgorithm roundingAlgorithm)public void ApplyRoundingForCurrency(RoundingAlgorithm roundingAlgorithm)Public Function ApplyRoundingForCurrency(roundingAlgorithm As RoundingAlgorithm) As void
Parameters
roundingAlgorithm
RoundingAlgorithm RoundingAlgorithm RoundingAlgorithm

The desired rounding algorithm for the currency. This must be one of the members of RoundingAlgorithm, excluding None.

Attributes

Remarks

ApplyRoundingForCurrency initializes NumberRounder to an IncrementNumberRounder object whose increment is set such that the inputs to Format will be rounded to the number of fraction digits established by Currency. The number of fraction digits can be obtained from the default value of the FractionDigits property.

Format(Double) Format(Double) Format(Double)

Returns a string representation of a Double currency value.

public string Format(Double value)public string Format(Double value)Public Function Format(value As Double) As string
Parameters
value
System.Double System.Double System.Double

The Double currency value to be formatted.

Returns
string string string

A string that represents the value.

Attributes

Remarks

See the remarks for @Windows.Globalization.NumberFormatting.CurrencyFormatter.#ctor(System.String,Windows.Foundation.Collections.IIterable{System.String},System.String)?text=CurrencyFormatter((String, IIterable(String), String)) for an explanation of how the currency code may be displayed when the currency symbol is ambiguous.

Format(Int64) Format(Int64) Format(Int64)

Returns a string representation of an Int64 currency value.

public string Format(Int64 value)public string Format(Int64 value)Public Function Format(value As Int64) As string
Parameters
value
System.Int64 System.Int64 System.Int64

The Int64 currency value to be formatted.

Returns
string string string

A string that represents the value.

Attributes

Remarks

See the remarks for @Windows.Globalization.NumberFormatting.CurrencyFormatter.#ctor(System.String,Windows.Foundation.Collections.IIterable{System.String},System.String)?text=CurrencyFormatter((String, IIterable(String), String)) for an explanation of how the currency code may be displayed when the currency symbol is ambiguous.

Format(UInt64) Format(UInt64) Format(UInt64)

Returns a string representation of a UInt64 currency value.

public string Format(UInt64 value)public string Format(UInt64 value)Public Function Format(value As UInt64) As string
Parameters
value
System.UInt64 System.UInt64 System.UInt64

The UInt64 currency value to be formatted.

Returns
string string string

A string that represents the value.

Attributes

Remarks

See the remarks for @Windows.Globalization.NumberFormatting.CurrencyFormatter.#ctor(System.String,Windows.Foundation.Collections.IIterable{System.String},System.String)?text=CurrencyFormatter((String, IIterable(String), String)) for an explanation of how the currency code may be displayed when the currency symbol is ambiguous.

FormatDouble(Double) FormatDouble(Double) FormatDouble(Double)

Returns a string representation of a Double currency value.

public string FormatDouble(Double value)public string FormatDouble(Double value)Public Function FormatDouble(value As Double) As string
Parameters
value
System.Double System.Double System.Double

The Double currency value to be formatted.

Returns
string string string

A string that represents the value.

Attributes

FormatInt(Int64) FormatInt(Int64) FormatInt(Int64)

Returns a string representation of an Int64 currency value.

public string FormatInt(Int64 value)public string FormatInt(Int64 value)Public Function FormatInt(value As Int64) As string
Parameters
value
System.Int64 System.Int64 System.Int64

The Int64 currency value to be formatted.

Returns
string string string

A string that represents the value.

Attributes

FormatUInt(UInt64) FormatUInt(UInt64) FormatUInt(UInt64)

Returns a string representation of a UInt64 currency value.

public string FormatUInt(UInt64 value)public string FormatUInt(UInt64 value)Public Function FormatUInt(value As UInt64) As string
Parameters
value
System.UInt64 System.UInt64 System.UInt64

The UInt64 currency value to be formatted.

Returns
string string string

The UInt64 currency value to be formatted.

Attributes

ParseDouble(String) ParseDouble(String) ParseDouble(String)

Attempts to parse a string representation of a Double currency value.

public IReference<double> ParseDouble(String text)public IReference<double> ParseDouble(String text)Public Function ParseDouble(text As String) As IReference( Of double )
Parameters
text
System.String System.String System.String

The text to be parsed.

Returns

If successful, a Double that corresponds to the string representation, and otherwise null.

Attributes

ParseInt(String) ParseInt(String) ParseInt(String)

Attempts to parse a string representation of an integer currency value.

public IReference<long> ParseInt(String text)public IReference<long> ParseInt(String text)Public Function ParseInt(text As String) As IReference( Of long )
Parameters
text
System.String System.String System.String

The text to be parsed.

Returns

If successful, an Int64 that corresponds to the string representation, and otherwise null.

Attributes

ParseUInt(String) ParseUInt(String) ParseUInt(String)

Attempts to parse a string representation of an unsigned integer currency value.

public IReference<ulong> ParseUInt(String text)public IReference<ulong> ParseUInt(String text)Public Function ParseUInt(text As String) As IReference( Of ulong )
Parameters
text
System.String System.String System.String

The text to be parsed.

Returns

If successful, a UInt64 that corresponds to the string representation, and otherwise null.

Attributes

See Also