|
FormatNumber Function |
Main Menu |
Syntax
FormatNumber(Expression[,NumDigitsAfterDecimal
[,IncludeLeadingDigit [,UseParensForNegativeNumbers [,GroupDigits]]]])
The FormatNumber 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. |
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.
For example.
Dim Pi,
LowPi, FracPi
Pi = 4 * Atn(1) '
pi now contains the value of 3.14159265358979
LowPi = 0 - Pi '
LowPi has the value of -3.14159265358979
FracPi = Pi - 3 ' FracPi with
the value of 0.14159265358979
data = FormatNumber(Pi)
The value of data on default setting on a UK setup 2003 windows server runing
ASP would be "3.14" and as this is run localy to the server that would
be what is seen only based on the test server.
As servers can be set up differently in other countries and for other reasons
this would have to be tested to see what the return result actually would be
locally to the particular code being run.
data
= FormatNumber(Pi, 5) ' data should contain "3.14159"
data = FormatNumber(Pi, 1) '
data should contain "3.1"
data
= FormatNumber(FracPi,
6, False) '
data should contain ".141592"
data
= FormatNumber(FracPi, 6, True) '
data should contain "0.141592"
data =
FormatNumber(LowPi,3,True,False)
' data would contain "-3.142"
data = FormatNumber(LowPi,3,True,True) ' data would
contain "(3.142)"
data =
FormatNumber(Pi * 10000000,2,,,False)
' data should equal "31415926.54"
data = FormatNumber(Pi * 10000000,2,,,True)
' data should equal "31,415,926.54"
related to
FormatCurrency FormatDateTime
FormatPercent
|