This is preliminary documentation and subject to change.
To comment on this topic, please send us email at ngwssdk@microsoft.com. Thanks!
FormatNumber Function
Returns an expression formatted as a number.
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 locale 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 locale settings. See Settings section for values.
Settings
The IncludeLeadingDigit, UseParensForNegativeNumbers, and GroupDigits arguments have the following settings:
Constant |
Value |
Description |
True |
–1 |
True |
False |
0 |
False |
Default |
–2 |
Use the setting from the computer's regional settings. |
Remarks
When one or more optional arguments are omitted, the values for omitted arguments are provided by the locale settings.
Note All settings information comes from the locale of the application. by default, that will be the locale set in the control panel. However, it may be changed programmatically by using NGWS frameworks in System.Globalization.CultureInfo
.
See Also
FormatCurrency Function | FormatDateTime Function | FormatPercent Function