__N

(part of PKLOC)

Return Type: string

Parameters: theNumber [, theFormat [, theLocale ] ]

Localizes a number according the user's current locale (or the given locale) based on the format specified. The format is based on the format rules specified here, except that this method automatically adds the "n". Therefore a format of "2" will automatically become "n2".

For example:

__N( 1234.5 )               ==>   1,234.5
__N( 1234.5, "0" )          ==>   1,234
__N( 1234.5, "1","en-US" )  ==>   1,234.5
__N(-1234.5 )               ==>  -1,234.5

Notes

The initializeGlobalization method must have been called prior to using this method, and the appropriate localization files need to have been loaded with loadLocales.

Version

0.1 Introduced

0.2 Docs Valid