FormatPercent Function
Returns an expression formatted as a percentage (multiplied by 100) with a
trailing % character.
FormatPercent(Expression[,NumDigitsAfterDecimal
[,IncludeLeadingDigit [,UseParensForNegativeNumbers
[,GroupDigits]]]])
The FormatPercent function syntax has these parts:
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 | | TristateTrue | -1 | True | | TristateFalse | 0 | False | | TristateUseDefault | -2 | Use the setting from the computer's regional settings. |
Remarks
When one or more optional arguments are omitted, the values for the omitted
arguments are provided by the computer's regional settings.
Note All settings information comes from the
Regional Settings Number tab.
The following example uses the FormatPercent function to format an
expression as a percent: Dim MyPercent
MyPercent = FormatPercent(2/32) ' MyPercent contains 6.25%.
|