FormatNumber Function

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. 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 control panel. See Settings section for values.

Settings

The IncludeLeadingDigit, UseParensForNegativeNumbers, and GroupDigits arguments have the following settings:

Constant

Value

Description

vbUseDefault

-2

Use default from computer's regional settings.

vbTrue

-1

True

vbFalse

0

False

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 example illustrates the use of the FormatNumber statement.

Dim number
number = -12345.6789123

' The NumDigitsAfterDecimal parameter is set to 3.
MsgBox (FormatNumber(number, 3))

' The UseParensForNegativeNumbers parameter is set to true.
MsgBox (FormatNumber (number, 3, , vbTrue))

' The GroupDigits parameter is set to false.
MsgBox (FormatNumber (number, 3, , , vbFalse))

Requirements

Version 2

Change History

Date

History

Reason

April 2009

Modified tristate constants table.

Content bug fix.

April 2009

Modified example.

Customer feedback.

See Also

FormatCurrency Function
FormatDateTime Function
FormatPercent Function