Method: FormatNumber for VBS

Download PDF

Formats a number.

vFormatNumber = Object.FormatNumber(expression, [NumDigitsAfterDecimal], [IncludeLeadingDigit], [UseParensForNegativeNumbers], [GroupDigits])

Object	VBS Object with this method. You do not need to specify this object.
expression	Variant Specifies the expression to be formatted.
[NumDigitsAfterDecimal]	Variant Specifies the number of decimal places behind the decimal separator. If you do not specify a value, the FormatNumber method uses the value -1, which means that the method uses the regional settings of your computer.
[IncludeLeadingDigit]	Variant Specifies whether the FormatNumber method displays leading zeros. Valid values are vbTrue, vbFalse, and vbUseDefault.
[UseParensForNegativeNumbers]	Variant Specifies whether the FormatNumber method displays negative numbers in parentheses. Valid values are vbTrue, vbFalse, and vbUseDefault.
[GroupDigits]	Variant Specifies whether the FormatNumber method groups numbers. Valid values are vbTrue, vbFalse, and vbUseDefault.
vFormatNumber	Variant Receives the formatted number.

The following example displays various formats for a number:

Dim MyNumber 
MyNumber = -12345.6789
Call MsgBox(FormatNumber (MyNumber))
' Do not group digits
Call MsgBox(FormatNumber (MyNumber, , , , vbFalse))

DIAdem Help