Click here to return to the KiXtart HelpDesk main page...

KiXtart 2001 Manual

FormatNumber( )

Action: Returns an expression formatted as a number.
 
Syntax: FormatNumber (expression, decimalplaces, leadingdigit, parentheses, group)
 
Parameters: Expression

Any valid numeric expression.

DecimalPlaces

Optional numeric value indicating how many places to the right of the decimal are displayed. Default value is -1, which indicates that the computer's regional settings are used.

LeadingDigit

Optional tri-state constant that indicates whether or not a leading zero is displayed for fractional values. See below for values. 

Parenthesis

Optional tri-state constant that indicates whether or not to place negative values within parentheses. See below for values. 

Group

Optional tri-state constant that indicates whether or not numbers are grouped using the group delimiter specified in the control panel. Possible values:

-1 True
0 False
-2 Use the setting from the computer's regional settings
 
Returns: The number, formatted as requested.
 
See Also: CDbl( ), CInt( ), CStr( ), Round( )
 
Example: