|
FormatPercent Function |
Main Menu |
Syntax
FormatPercent(Expression[,NumDigitsAfterDecimal
[,IncludeLeadingDigit [,UseParensForNegativeNumbers [,GroupDigits]]]])
The FormatPercent function syntax has these parts:
| Part | 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 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. |
When one or more optional arguments are omitted, the values for the omitted arguments are provided by the computer's regional settings.
For example.
Dim X, Y, Z, Info
X
= 0.33333333
Y = 0.00666666
Z = -0.175
Info
= FormatPercent(Z)
' Info value might be "33.33%"
The value of info can only be approximated at, as these returned values are
dependent upon the confederation settings after particular computer running
the VBScript or ASP. therefore the values indicated for the examples here are
known only to be true for the test system that was actually running the code.
This does not make the example valueless, as it still can be used as a basis
to understand the functionality.
Info
= FormatPercent(X,
5) ' Info
should contain "3.33333%"
Info
= FormatPercent(X,
1) ' Info
should contain "3.3%"
Info
= FormatPercent(Y,
3,
False ) ' Info
should contain ".667%"
Info
= FormatPercent(Y,
3, True
) ' Info
should contain "0.667%"
Info
= FormatPercent(Z,,,
False ) ' Info
should contain "-17.50%"
Info
= FormatPercent(Z,,,
True
) ' Info
should contain "(17.50%)"
Info
= FormatPercent(X
* 10000000,,,,
False ) ' Info
should contain "333333330.00%"
Info
= FormatPercent(X
* 10000000,,,, True
) ' Info
should contain "333,333,330.00%"
related to
FormatCurrency FormatDateTime
FormatNumber
|