Format
FormatCurrency(expression[, fractionaldigits[, leadingdigit[, parensfornegative[, groupdigits]]]])
FormatDateTime(date[, formatname])
FormatNumber(expression[, fractionaldigits[, leadingdigit[, parensfornegative[, groupdigits]]]])
FormatPercent(expression[, fractionaldigits[,leadingdigit[, parensfornegative[, groupdigits]]]])
Description
FormatCurrency, FormatNumber, and FormatPercent return a string obtained by formatting the given expression as a currency, number, or percent. The required parameter, expression, is any valid expression of the given type. The optional parameter, fractionaldigits, is a numeric expression representing the number of digits to print after the decimal, the default is -1 which uses the system settings. The optional parameters, leadingdigit, parensfornegative, and groupdigits, are numeric expressions or constants, see below. leadingdigit specifies whether a leading zero is printed for numbers with only fractional parts. parensfornegative specifies if negative values are to be printed with enclosing parentheses. groupdigits specifies if numbers are to be printed in groups using the systems group delimiter.
Table 11: Tristate values
| Name | Value | Description |
|---|---|---|
| True | -1 | True |
| False | 0 | False |
| TriStateUseDefault | -2 | Use system settings |
FormatDateTime returns a string obtained by formatting a date. The required parameter, date, is any valid expression that represents a date. The optional parameter, formatname, is a numeric expression or constant that specifies how the date is formatted.
Table 12: formatname constants
| Constant | Value | Description |
|---|---|---|
| vbGeneralDate | 0 | Short date, Long time |
| vbLongDate | 1 | Long date |
| vbShortDate | 2 | Short date |
| vbLongTime | 3 | Long time |
| vbShortTime | 4 | Short time |
Example
Rem Format Functions
Dim UseDefault
UseDefault=-2
'Currency
Print FormatCurrency(-3.5, -1, _
TristateUseDefault, True)
Print FormatCurrency(123456, 0,True, False, True)
'Date/Time
Print FormatDateTime(Now)
Print FormatDateTime(Birthdate, vbLongDate)
'General Numbers
Print FormatNumber(-0.1429, 6,False)
Print FormatNumber(987654.321, 3, True, False, True)
'Percentages
Print FormatPercent(0.007, 2, False)
Print FormatPercent(1234.56, 0,True, False, False)
Output
($3.50) $123,456 8/18/1998 10:44 PM August 18, 1998 -.142900 987,654.321 .70% 123456% (sample output is system dependant)