FormatCurrency Function
This page is specific to the Visual Basic for Applications (VBA) Language Reference for Office 2010.
Description
Returns an expression formatted as a currency value using the currency symbol defined in the system control panel.
Syntax
FormatCurrency(Expression[,NumDigitsAfterDecimal [,IncludeLeadingDigit [,UseParensForNegativeNumbers [,GroupDigits]]]])
The FormatCurrency 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 computer's regional settings. See Settings section for values. |
Settings
The IncludeLeadingDigit, UseParensForNegativeNumbers, and GroupDigits arguments have the following settings:
Constant |
Value |
Description |
|---|---|---|
vbTrue |
–1 |
True |
vbFalse |
0 |
False |
vbUseDefault |
–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 computer's regional settings.
The position of the currency symbol relative to the currency value is determined by the system's regional settings.
Note
All settings information comes from the Regional Settings Currency tab, except leading zero which comes from the Number tab.