Money# - script and chart function
Money#() converts a text string to a money value, in the format set in the load script or the operating system, unless a format string is supplied. Custom decimal and thousand separator symbols are optional parameters.
Syntax:
Money#(text[, format[, dec_sep [, thou_sep ] ] ])
Return data type: dual
Argument | Description |
---|---|
text | The text string to be evaluated. |
format |
String describing the expected input format to use when converting the string to a numeric interval.
If omitted, the value set in the data load script for MoneyFormat is used. The Money# function supports many format options for different money structures, for example: $#,##0.00: Adds a dollar sign and two decimal places. € #,##0: Adds a euro sign and no decimal places, with a space after the euro sign. ¥#,##0: Adds a Japanese yen sign with no decimal places. $#,##0;($#,##0): Formats negative values in parentheses. ₣ #.##0,00: Adds a Swiss franc sign with periods as thousand separators and a comma for decimals (for example, ₣ 1.000,00). R #,##0.00: South African rand sign with two decimal places and space after the rand symbol. $ #,##0.000: Adds three decimal places to the dollar format. |
dec_sep | String specifying the decimal number separator. If omitted, the MoneyDecimalSep value set in the data load script is used.
The Money# function supports many decimal number separator formats, for example: Comma ' , ': For example, $1,000,00 for one thousand dollars. Period ' . ': For example, € 1,000.00. Hyphen ' - ': When used instead of the traditional period or comma for the decimal separator, it shows values like ¥1,000-00. |
thou_sep |
String specifying the thousands number separator. If omitted, the MoneyThousandSep value set in the data load script is used. The Money# function supports many options for the thousands number separator: Period ' . ': Uses a period for the thousands separator (common in some European formats), displaying as $1.000,00 if combined with a comma decimal separator. Space ' ': Uses a space for the thousands separator, which is common in some European countries. Displays as € 1 000.00. Underscore '_': Uses an underscore for the thousands separator, which is sometimes used in technical or specific regional formats. Displays values like $1_000.00. |
The Money# function generally behaves like the Num# function but takes its default values for the decimal and thousand separators from the script variables for money format or the system settings for currency.
Example | Results |
---|---|
Money#('35 648,37 kr' , '# ##0,00 kr',',',' ' ) |
Returns 35 648,37 kr when the MoneyFormat setting is # ##0,00 kr. The following need to be set in your load script for this to evaluate correctly as a number:
|
Money#( '$35,648.37', ' $#', '.', ',' ) |
Returns $35,648.37 when the following is set:
|