FormatNumber

Returns an expression formatted as a number.

Structure

FormatNumber(Expression [,NumDigitsAfterDecimal [,IncludeLeadingDigit [,UseParensForNegativeNumbers [,GroupDigits]]]])

Parameters

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.

Parameter Values

The IncludeLeadingDigit, UseParensForNegativeNumbers, and GroupDigits Structure have the following values:

Constant Value Description

TristateTrue -1 True

TristateFalse 0 False

TristateUseDefault -2 Use the setting from the computer's regional settings.

Description

When one or more of the optional Structure are omitted, the values for omitted Structure are provided by the computer's regional settings.

Note

All settings information comes from the Regional Settings Number tab.

Example

The following example uses the FormatNumber function to format a number to have four decimal places:

Function FormatNumberDemo

Dim MyAngle, MySecant, MyNumber

MyAngle = 1.3 ' Define angle in radians.

MySecant = 1 / Cos(MyAngle) ' Calculate secant.

FormatNumberDemo = FormatNumber(MySecant,4) ' Format MySecant to four decimal places.

End Function |