DevGuru VBScript Function: FormatNumber

FUNCTION: FormatNumber( )

Implemented in version 2.0

FormatNumber(Expression, NumDigitsAfterDecimal, IncludeLeadingDigit, UseParensForNegativeNumbers, GroupDigit)

The FormatNumber function return a formatted number value for the numeric expression.

There is one mandatory argument.

Expression

The Expression argument is the number to be converted to a formatted number.

Code:
<% =FormatNumber(12345) %>

Output:
12,345.00

Note that this function rounds off values.

Code:
<% =FormatNumber(12345.67899) %>

Output:
12,345.68

There are 4 optional arguments.

NumDigitsAfterDecimal

The optional NumDigitsAfterDecimal argument allows you to choose the number of digits after the decimal.

Code:
<% =FormatNumber(12345.67899, 4) %>

Output:
12,345.6790

IncludeLeadingDigit

The optional IncludeLeadingDigit argument includes the leading zero.

You must only use the constant or value from the Tristate CONSTANTS for this argument.

CONSTANT	VALUE	DESCRIPTION
TristateTrue	-1	True, will use options
TristateFalse	0	False, will not use options
TristateUseDefault	-2	Use default setting

Code:
<% =FormatNumber(.77, 4, -1) %>

Output:
0.7700

UseParensForNegativeNumbers

The optional UseParensForNegativeNumber argument replaces a negative sign with parentheses around the number.

You must only use the constant or value from the Tristate CONSTANTS for this argument.

CONSTANT	VALUE	DESCRIPTION
TristateTrue	-1	True, will use options
TristateFalse	0	False, will not use options
TristateUseDefault	-2	Use default setting

Code:
<% =FormatNumber(-12345.67899, 2, 0, -1) %>

Output:
(12,345.68)

GroupDigit

The optional GroupDigit argument allows the use of the options specified in the Regional Settings Properties in the Control Panel to display a number.

You must only use the constant or value from the Tristate CONSTANTS for this argument.

CONSTANT	VALUE	DESCRIPTION
TristateTrue	-1	True, will use options
TristateFalse	0	False, will not use options
TristateUseDefault	-2	Use default setting