Difference between revisions of "SsParseNum"

From SmartWiki
Jump to: navigation, search
(→‎When Using "Show Currency Format in Edit Mode")
(→‎When Using "Show Currency Format in Edit Mode")
 
(4 intermediate revisions by 2 users not shown)
Line 40: Line 40:
 
  <SCRIPT type="text/javascript" language="javascript" src="/sstools.js"></SCRIPT>
 
  <SCRIPT type="text/javascript" language="javascript" src="/sstools.js"></SCRIPT>
  
−
==When Using "Show Currency Format in Edit Mode"==
+
==When Using "Show Currency Format in Edit Mode"==
−
When using the "Show Currency Format in Edit Mode" setting for custom fields, the following syntax must be used:  
+
When using the "Show Currency Format in Edit Mode" setting for custom fields, the following syntax must be used:
  
−
:<font size="3">'''ssParseNumByCode( ''value'',''emptyok'',' ''code'' ');''' </font>
+
: <span style="font-size: medium;">'''ssParseNumFromCurrency(value,getLocalestrByCurrency(code),1,emptyok);''' ''(getLocalestrByCurrency will get the "default" locale of the currency code, e.g. CAD will result in en-CA, NOT fr-CA)'''''<br /><br />OR<br /><br />ssParseNumFromCurrency(value,locale,1,emptyok); '''''(if you know the locale of the formatted currency, e.g. da-DK or fr-FR or fr-CA etc)'''<br />'''''</span>
−
 
+
Where:
−
Where: <br / >
 
  
 
{| border="1"
 
{| border="1"
−
!Parameter
 
−
!Description
 
 
|-
 
|-
−
|<b><em>value </em></b>
+
!|Parameter
−
|Required. Is the value to be converted to a number (i.e: $5,000.00 and 5,000% will be converted to 5000)<br />
+
!|Description
 
|-
 
|-
−
|<b><em>emptyok </em></b>
+
||'''''value '''''
−
|Optional. Is a true/false value
+
||Required. Is the value to be converted to a number (i.e: $5,000.00 and 5,000 will be converted to 5000)
−
:*if ''emptyok'' is true - an empty string will be returned by ssParseNumByCode if the value is ''empty''
+
|-
−
:*if ''emptyok'' is false - a "0" will be returned by ssParseNumByCode if the value is ''empty''
+
||'''''emptyok '''''
 +
||Optional. Is a true/false value
 +
:* if ''emptyok'' is true - an empty string will be returned by if the value is ''empty''
 +
:* if ''emptyok'' is false - a "0" will be returned by if the value is ''empty''
 +
 
 
|-
 
|-
−
|<b><em>code</em></b>
+
||'''''code'''''
−
|Required. The three-letter currency code defined by [http://en.wikipedia.org/wiki/ISO_4217 ISO 4217]. Example: ''JPY'' for Japanese Yen.
+
||Required. The three-letter currency code defined by [http://en.wikipedia.org/wiki/ISO_4217 ISO 4217]. Example: ''JPY'' for Japanese Yen.
 
|}
 
|}
  
 
Example:
 
Example:
  
−
:<font size="3">'''ssParseNumByCode([YER Total revenue],0,"CAD") - ssParseNumByCode([YER Total expenses],0,"CAD")</font>
+
: <span style="font-size: medium;">ssParseNumFromCurrency([YER Total revenue],getLocalestrByCurrency('CAD'),1,true) - ssParseNumFromCurrency([YER Total expenses],getLocalestrByCurrency('CAD'),1,true)<br /></span>
 +
: <span style="font-size: medium;">or</span>
 +
: <span style="font-size: medium;">ssParseNumFromCurrency([YER Total revenue],'fr-CA',1,true) - ssParseNumFromCurrency([YER Total expenses],'fr-CA',1,true)  <br /><br /></span>
  
 
==See Also==
 
==See Also==

Latest revision as of 12:46, 19 May 2021

This feature uses JavaScript syntax
Text code javascript.gif

Overview

To convert a number from a formatted string (containing symbols like "$" or "%") to a number using JavaScript you can use a function called ssParseNum.

Syntax

ssParseNum( value, emptyok );

Where:

Parameter Description
value Required. Is the value to be converted to a number (i.e: $5,000.00 and 5,000% will be converted to 5000)
emptyok Optional. Is a true/false value
  • if emptyok is true - an empty string will be returned by ssParseNum if the value is empty
  • if emptyok is false - a "0" will be returned by ssParseNum if the value is empty

Examples

ssParseNum($5,000.50);

Will return: 5000.5

If you wish to display a ratio of two fields that are set to have currency formatting, you should convert the values to numbers using ssParseNum: 

ssParseNum([field1])/ssParseNum([field2])

Requirements

This function is part of the sstools.js library and needs to be added to Browser Script custom fields or on template pages, sign-up pages etc. using the following syntax: 

<SCRIPT type="text/javascript" language="javascript" src="/sstools.js"></SCRIPT>

When Using "Show Currency Format in Edit Mode"

When using the "Show Currency Format in Edit Mode" setting for custom fields, the following syntax must be used:

ssParseNumFromCurrency(value,getLocalestrByCurrency(code),1,emptyok); (getLocalestrByCurrency will get the "default" locale of the currency code, e.g. CAD will result in en-CA, NOT fr-CA)

OR

ssParseNumFromCurrency(value,locale,1,emptyok); (if you know the locale of the formatted currency, e.g. da-DK or fr-FR or fr-CA etc)

Where:

Parameter Description
value Required. Is the value to be converted to a number (i.e: $5,000.00 and 5,000 will be converted to 5000)
emptyok Optional. Is a true/false value
  • if emptyok is true - an empty string will be returned by if the value is empty
  • if emptyok is false - a "0" will be returned by if the value is empty
code Required. The three-letter currency code defined by ISO 4217. Example: JPY for Japanese Yen.

Example:

ssParseNumFromCurrency([YER Total revenue],getLocalestrByCurrency('CAD'),1,true) - ssParseNumFromCurrency([YER Total expenses],getLocalestrByCurrency('CAD'),1,true)
or
ssParseNumFromCurrency([YER Total revenue],'fr-CA',1,true) - ssParseNumFromCurrency([YER Total expenses],'fr-CA',1,true)  

See Also

Retrieved from ‘https://wiki.smartsimple.com/index.php?title=SsParseNum&oldid=38408’