FormatNumber
Returns an expression formatted as a number.
Syntax: FormatNumber( expression [ , numDigitsAfterDecimal [ , includeLeadingDigit [ , useParensForNegativeNumbers [ , groupDigits ] ] ] ] )
- 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 Tristate constant that indicates whether or not a leading zero is displayed for fractional values. See settings below.
- useParensForNegativeNumbers
- optional Tristate constant that indicates whether or not to place negative values within parentheses. See settings below.
- groupDigits
- optional Tristate constant that indicates whether or not numbers are grouped by using the group delimiter specified in the computer’s regional settings. See settings below.
The includeLeadingDigit, useParensForNegativeNumbers, and groupDigits arguments have the following settings:
| Constant | Value | Description |
|---|---|---|
| vbTrue | -1 | True |
| vbFalse | 0 | False |
| vbUseDefault | -2 | Use the setting from the computer’s regional settings. |
When one or more optional arguments are omitted, the values for omitted arguments are provided by the computer’s regional settings.
See Also
- Format, FormatCurrency, FormatPercent functions