CurrencyFormatter CurrencyFormatter CurrencyFormatter CurrencyFormatter Class

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

public : CurrencyFormatter(PlatForm::String currencyCode)public CurrencyFormatter(String currencyCode)Public Sub New(currencyCode As String)// You can use this method in JavaScript.

See Also

CurrencyFormatter(String, IIterable<String>, String)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(PlatForm::String currencyCode, IIterable<PlatForm::String> languages, PlatForm::String geographicRegion)public CurrencyFormatter(String currencyCode, IEnumerable<String> languages, String geographicRegion)Public Sub New(currencyCode As String, languages As IEnumerable<String>, geographicRegion As String)// You can use this method in JavaScript.

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, CurrencyFormatter ("USD", ["en"], "CA") creates a formatter that formats 3 as 3 CAD, even if the Mode property is UseSymbol. Similarly, 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

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

Unicode Key/Type Definitions

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

public : PlatForm::String Currency { get; set; }public string Currency { get; set; }Public ReadWrite Property Currency As string// You can use this property in JavaScript.

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// You can use this property in JavaScript.

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

public : PlatForm::String GeographicRegion { get; }public string GeographicRegion { get; }Public ReadOnly Property GeographicRegion As string// You can use this property in JavaScript.

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// You can use this property in JavaScript.

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

public : PlatForm::Boolean IsDecimalPointAlwaysDisplayed { get; set; }public bool IsDecimalPointAlwaysDisplayed { get; set; }Public ReadWrite Property IsDecimalPointAlwaysDisplayed As bool// You can use this property in JavaScript.

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

public : PlatForm::Boolean IsGrouped { get; set; }public bool IsGrouped { get; set; }Public ReadWrite Property IsGrouped As bool// You can use this property in JavaScript.

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 : PlatForm::Boolean IsZeroSigned { get; set; }public bool IsZeroSigned { get; set; }Public ReadWrite Property IsZeroSigned As bool// You can use this property in JavaScript.

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".

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

public : IVectorView<string> Languages { get; }public IReadOnlyList<string> Languages { get; }Public ReadOnly Property Languages As IReadOnlyList<string>// You can use this property in JavaScript.

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.

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// You can use this property in JavaScript.

Remarks

See the remarks for 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.

See Also

CurrencyFormatterModeCurrencyFormatterModeCurrencyFormatterModeCurrencyFormatterMode

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// You can use this property in JavaScript.

Remarks

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

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

public : PlatForm::String NumeralSystem { get; set; }public string NumeralSystem { get; set; }Public ReadWrite Property NumeralSystem As string// You can use this property in JavaScript.

See Also

NumeralSystem values

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

public : PlatForm::String ResolvedGeographicRegion { get; }public string ResolvedGeographicRegion { get; }Public ReadOnly Property ResolvedGeographicRegion As string// You can use this property in JavaScript.

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

public : PlatForm::String ResolvedLanguage { get; }public string ResolvedLanguage { get; }Public ReadOnly Property ResolvedLanguage As string// You can use this property in JavaScript.

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.

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// You can use this property in JavaScript.

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.

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// You can use this method in JavaScript.

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.

See Also

RoundingAlgorithmRoundingAlgorithmRoundingAlgorithmRoundingAlgorithm

Returns a string representation of a Double currency value.

public : PlatForm::String Format(double value)public string Format(Double value)Public Function Format(value As Double) As string// You can use this method in JavaScript.

Remarks

See the remarks for CurrencyFormatter((String, IIterable(String), String)) for an explanation of how the currency code may be displayed when the currency symbol is ambiguous.

See Also

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

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

Returns a string representation of an Int64 currency value.

public : PlatForm::String Format(long value)public string Format(Int64 value)Public Function Format(value As Int64) As string// You can use this method in JavaScript.

Remarks

See the remarks for CurrencyFormatter((String, IIterable(String), String)) for an explanation of how the currency code may be displayed when the currency symbol is ambiguous.

See Also

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

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

Returns a string representation of a UInt64 currency value.

public : PlatForm::String Format(unsigned __int64 value)public string Format(UInt64 value)Public Function Format(value As UInt64) As string// You can use this method in JavaScript.

Remarks

See the remarks for CurrencyFormatter((String, IIterable(String), String)) for an explanation of how the currency code may be displayed when the currency symbol is ambiguous.

See Also

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

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

Returns a string representation of a Double currency value.

public : PlatForm::String FormatDouble(double value)public string FormatDouble(Double value)Public Function FormatDouble(value As Double) As string// You can use this method in JavaScript.

Returns a string representation of an Int64 currency value.

public : PlatForm::String FormatInt(long value)public string FormatInt(Int64 value)Public Function FormatInt(value As Int64) As string// You can use this method in JavaScript.

Returns a string representation of a UInt64 currency value.

public : PlatForm::String FormatUInt(unsigned __int64 value)public string FormatUInt(UInt64 value)Public Function FormatUInt(value As UInt64) As string// You can use this method in JavaScript.

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

public : IReference<double> ParseDouble(PlatForm::String text)public Nullable<double> ParseDouble(String text)Public Function ParseDouble(text As String) As Nullable( Of double )// You can use this method in JavaScript.

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

public : IReference<long> ParseInt(PlatForm::String text)public Nullable<long> ParseInt(String text)Public Function ParseInt(text As String) As Nullable( Of long )// You can use this method in JavaScript.

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

public : IReference<ulong> ParseUInt(PlatForm::String text)public Nullable<ulong> ParseUInt(String text)Public Function ParseUInt(text As String) As Nullable( Of ulong )// You can use this method in JavaScript.