Returns an expression formatted as a number.
Syntax
FormatNumber ( Expression [, NumDigitsAfterDecimal ] [, IncludeLeadingDigit ] [, UseParensForNegativeNumbers ] [, GroupDigits ] )
The FormatNumber function syntax has these arguments:
|
Argument |
Description |
|
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 section for values. |
|
UseParensForNegativeNumbers |
Optional. Tristate constant that indicates whether or not to place negative values within parentheses. See Settings section for values. |
|
GroupDigits |
Optional. Tristate constant that indicates whether or not numbers are grouped using the group delimiter specified in the computer's regional settings. See Settings section for values. |
Settings
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. |
Remarks
When one or more 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.
Examples
|
Expression |
Results |
|
SELECT FormatNumber([SalePrice]) AS Expr1 FROM ProductSales; |
Formats the currency values in "SalePrice" field into "Number" format and returns in column Expr1. |
|
SELECT FormatNumber([Discount],2,-1,-1,-1) AS DiscountedPrice FROM ProductSales; |
Formats the number values in "Discount" field into "Number" format with 2 decimal points, all less than 1 values will have "0" before the decimal, negative values will covered in parentheses, the value will be grouped by default delimiter ("1000" will be displayed as 1,000.00, "-1000" will be displayed as (1,000.00), "0" will be displayed as 0.00). |
