CNumToLocale (NL)

<< Click to Display Table of Contents >>

Manual > Control Reference > Route > Route Methods >

CNumToLocale (NL)


 

Converts a number to a locale-aware numeric string.

 


syntax

CNumToLocale(

         number

         [,decimalPlaces=-1]

         [,format]

         [,fault]

         )

 


Parameters

 

number

 

Type:

Number

 

A number.

 

decimalPlaces

 

Type:

Number

 

Number of decimal places. If -1 is specified, the format specified by format will be used. If -1 is specified and no format is specified, there will be no limit on the number of decimal places.

 

format

 

Type:

character

 

Number format name. If omitted, it will behave the same as if "@LOCALE" (regional format (auto-switching)) was specified.

 

fault

 

Type:

Boolean

 

A boolean value that indicates the fault state. The behavior when the fault state is passed follows the definition of the numeric format.

 

Return Value

 

 

Type:

character

 

The converted formatted numeric string.

 


hmtoggle_plus1Explanation

 

hint

This method is a beta implementation and its operation is not guaranteed.

 


Supported


Script Action

Browser script

Calculation Expression Syntax

 

 


reference