FormatNumber Functions
Returns an expression formatted as a number.
Syntax
FormatNumber(Expression [,NumDigitsAfterDecimal [,IncludeLeadingDigit
[,UseParensForNegativeNumbers [,GroupDigits]]]])
Arguments:
- Expression: Required. Expression to be formatted.
- NumDigitsAfterDecimal: 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.
- IncludeLeadingDigit: Optional. Constant that indicates whether or not a leading zero is displayed for fractional values. See Settings section for values.
- UseParensForNegativeNumbers: Optional. Constant that indicates whether or not to place negative values within parentheses. See Settings section for values.
- GroupDigits: Optional. Constant that indicates whether or not numbers are grouped using the group delimiter specified in the control panel. See Settings section for values.
Settings: The IncludeLeadingDigit, UseParensForNegativeNumbers, and GroupDigits arguments have the following settings:
Table 11-12 Settings: FormatNumber Function
| Value | Description |
|---|---|
| -1 | True |
| 0 | False |
| -2 | Use the setting from the computer's regional settings. |
Remarks:
When one or more of the optional arguments are omitted, the values for omitted arguments are provided by the computer's regional settings.
Note:
All settings information comes from the Regional Settings Number tab.
The following examples shows the usage of FormatNumber function
along with expected output:
Dim formattedNum
formattedNum = FormatNumber(20000)
'formattedNum Outputs: 20,000.00
formattedNum = FormatNumber(20000,2)
'formattedNum Outputs: 20,000.00
formattedNum = FormatNumber(20000,5)
'formattedNum Outputs: 20,000.00000
formattedNum = FormatNumber(.20)
'formattedNum Outputs: 0.20
formattedNum = FormatNumber(.20,2,0)
'formattedNum Outputs: .20
formattedNum = FormatNumber(.20,2,-1)
'formattedNum Outputs: 0.20
formattedNum = FormatNumber(-50)
'formattedNum Outputs: -50.00
formattedNum = FormatNumber(-50,1,-1,0)
'formattedNum Outputs: -50.0
formattedNum = FormatNumber(-50,1,-1,-1)
'formattedNum Outputs: (50.0)
formattedNum = FormatNumber(10000000)
'formattedNum Outputs: 10,000,000.00
formattedNum = FormatNumber(10000000,1,-1,-1,0)
'formattedNum Outputs: 10000000.0
formattedNum = FormatNumber(10000000,1,-1,-1,-1)
'formattedNum Outputs: 10,000,000.0