Description
Formats a number in a locale-specific currency format.
Returns
A formatted currency value. For countries in the Euro currency zone, the function uses the locale's rule's for formatting currency in euros.
Category
Syntax
LSEuroCurrencyFormat(currency [, type, locale])
See also
LSParseEuroCurrency, LSCurrencyFormat, SetLocale; Locale-specific content in the Developing ColdFusion Applications
ColdFusion uses the Spanish (Standard) formats for Spanish (Modern) and Spanish (Standard).
History
- ColdFusion (2018 release): Changed parameter name currency-number to currency.
- ColdFusion 8: Added the locale parameter.
- ColdFusion MX: Changed formatting behavior: this function might return different formatting than in earlier releases. This function uses Java locale formatting rules on all platforms, except that it uses the rule detailed in the Usage section for countries in the Euro currency zone. As a result, it format currencies for non-Euro zone locales using the country's currency, not euros.
Parameters
Parameter |
Description |
---|---|
currency |
Currency value. |
locale |
Locale to use instead of the locale of the page when processing the function |
type |
|
Usage
This function uses euro currency formatting rules for all JVM versions, as follows:
- If the country of the current locale belongs to the Euro Zone (whose members have converted to the euro) the formatted output for the local type includes the Euro currency sign; for the international type, the output includes the euro currency symbol (EUR). If the value is negative, the format includes a negative sign before the value or parentheses around the value, according to the formatting rules of the current locale.
- If the country of the current locale is not in the Euro Zone, the currency sign or symbol of the current locale displays. If the value is negative, the format includes a negative sign before the value or parentheses around the value, according to the formatting rules of the current locale.For a list of the locale options that ColdFusion supports, and information on setting the default display format of date, time, number, and currency values, see SetLocale.
Currency output
The following table shows examples of currency output:
Locale |
Type = Local |
Type = International |
Type = None |
---|---|---|---|
Chinese (China mainland) |
100,000.00 |
CNY100,000.00 |
100,000.00 |
Chinese (Hong Kong SAR of China) |
HK$100,000.00 |
HKD100,000.00 |
100,000.00 |
Chinese (Taiwan region) |
NT$100,000.00 |
TWD100,000.00 |
100,000.00 |
Dutch (Belgian) |
100.000,00 |
EUR100.000,00 |
100.000,00 |
Dutch (Standard) |
100.000,00 |
EUR100.000,00 |
100.000,00 |
English (Australian) |
$100,000.00 |
AUD100,000.00 |
100,000.00 |
English (Canadian) |
$100,000.00 |
CAD100,000.00 |
100,000.00 |
English (New Zealand) |
$100,000.00 |
NZD100,000.00 |
100,000.00 |
English (UK) |
100,000.00 |
GBP100,000.00 |
100,000.00 |
English (US) |
$100,000.00 |
USD100,000.00 |
100,000.00 |
French (Belgian) |
100.000,00 |
EUR100.000,00 |
100.000,00 |
French (Canadian) |
100 000,00 $ |
CAD100 000,00 |
100 000,00 |
French (Standard) |
100 000,00 |
EUR100 000,00 |
100 000,00 |
French (Swiss) |
SFr. 100'000.00 |
CHF100'000.00 |
100'000.00 |
German (Austrian) |
100.000,00 |
EUR100.000,00 |
100.000,00 |
German (Standard) |
100.000,00 |
EUR100.000,00 |
100.000,00 |
German (Swiss) |
SFr. 100'000.00 |
CHF100'000.00 |
100'000.00 |
Italian (Standard) |
100.000,00 |
EUR10.000.000 |
10.000.000 |
Italian (Swiss) |
SFr. 100'000.00 |
CHF100'000.00 |
100'000.00 |
Japanese |
100,000 |
JPY100,000 |
JPY100,000 |
Korean |
W100,000 |
KRW100,000 |
100,000 |
Norwegian (Bokmal) |
kr 100 000,00 |
NOK100 000,00 |
100 000,00 |
Norwegian (Nynorsk) |
kr 100 000,00 |
NOK100 000,00 |
100 000,00 |
Portuguese (Brazilian) |
R$100.000,00 |
BRC100.000,00 |
100.000,00 |
Portuguese (Standard) |
100.000,00 |
EUR100.000,00 |
100.000,00 |
Spanish (Mexican) |
$100,000.00 |
MXN100,000.00 |
100,000.00 |
Spanish (Modern) |
100.000,00 |
EUR10.000.000 |
10.000.000 |
Spanish (Standard) |
100.000,00 |
ESP10.000.000 |
10.000.000 |
Swedish |
100.000,00 kr |
SEK100.000,00 |
100.000,00 |
The following example shows how the function formats negative values. The format includes a negative sign before the value, or parentheses around the value, according to the formatting rules of the current locale.
Input value |
Output if locale = French (Standard) |
Output if locale = English (US) |
-1234.56 |
-1 234,56 |
($1,234.56) |
Example
<h3>LSEuroCurrencyFormat Example</h3> <p>LSEuroCurrencyFormat returns a currency value using the locale convention. Default value is "local." <!--- Loop through list of locales, show currency values for 100,000 units ---> <cfloop list = "#Server.Coldfusion.SupportedLocales#" index = "locale" delimiters = ","> <cfset oldlocale = SetLocale(locale)> <cfoutput><p><B><I>#locale#</I></B><br> Local: #LSEuroCurrencyFormat(100000, "local")#<br> International: #LSEuroCurrencyFormat(100000, "international")#<br> None: #LSEuroCurrencyFormat(100000, "none")#<br> <Hr noshade> </cfoutput> </cfloop>