Description
Formats an expression according to instructions contained in a format expression.
Syntax
Format(expression[,format])
The Format function syntax has these parts:
|
Part |
Description |
|
expression |
Any valid expression. |
|
format |
A valid named or user-defined format expression. |
Remarks
|
To Format These |
Do This |
|
Numbers |
Use predefined named numeric formats or create user-defined numeric formats. |
|
Dates and times |
Use predefined named date/time formats or create user-defined date/time formats. |
|
Date and time serial numbers |
Use date and time formats or numeric formats. |
|
Strings |
Create your own user-defined string formats. |
If you try to format a number without specifying format, Format provides the same functionality as the Str function. However, positive numbers formatted as strings using Format lack the leading space reserved for displaying the sign of the value; whereas, those converted using Str retain the leading space.
Example
This example shows various uses of the Format function to format values using both named and user-defined formats. For the date separator (/), time separator (:) and AM/ PM literal, the actual formatted output displayed by your system depends on the settings at the time. When times and dates are listed back in the development environment, the short time and short date formats of the code locale are used. When displayed by running code, the short time and short date formats of the system locale are used, which may be different from the code locale. For this example, English - US is assumed.
' MyTime and MyDate will be displayed in the development environment
' using current system short time and short date settings.
MyTime = #17:04:23#
MyDate = #January 27, 1993#
' Returns current system time in the system-defined long time format.
MyStr = Format(Time, "Long Time")
' Returns current system date in the system-defined long date format.
MyStr = Format(Date, "Long Date")
MyStr = Format(MyTime, "h:m:s") ' Returns "17:4:23".
MyStr = Format(MyTime, "hh:mm:ss AMPM") ' Returns "05:04:23 PM".
MyStr = Format(MyDate, "dddd, mmm d yyyy") ' Returns
' "Wednesday, Jan 27 1993".
' If format is not supplied, a string is returned.
MyStr = Format(23) ' Returns "23".
' User-defined formats.
MyStr = Format(5459.4, "##,##0.00") ' Returns "5,459.40".
MyStr = Format(334.9, "###0.00") ' Returns "334.90".
MyStr = Format(5, "0.00%") ' Returns "500.00%".
MyStr = Format("HELLO", "<") ' Returns "hello".
MyStr = Format("This is it", ">") ' Returns "THIS IS IT".
A format expression for numbers can have from one to four sections separated by semicolons. (If the format argument contains one of the predefined formats, only one section is allowed.)
|
If you use |
The result is |
|
One section only |
The format expression applies to all values. |
|
Two sections |
The first section applies to positive values and zeros, the second to negative values. |
|
Three sections |
The first section applies to positive values, the second to negative values, and the third to zeros. |
|
Four sections |
The first section applies to positive values, the second to negative values, the third to zeros, and the fourth to Null values. |
The following example has two sections: the first defines the format for positive values and zeros; the second section defines the format for negative values.
"$#,##0;($#,##0)"
If you include semicolons with nothing between them, the missing section is printed using the format of the positive value. For example, the following format displays positive and negative values using the format in the first section and displays "Zero" if the value is zero.
"$#,##0;;\Z\e\r\o"
Examples
Some sample format expressions for numbers are shown below. (These examples all assume that your system's locale setting is English-US.) The first column contains the format strings. The other columns contain the output that results if the formatted data has the value given in the column headings.
|
Format (format) |
Positive 5 |
Negative 5 |
Decimal .5 |
Null |
|
Zero-length string |
5 |
-5 |
0.5 | |
|
0 |
5 |
-5 |
1 | |
|
0.00 |
5.00 |
-5.00 |
0.50 | |
|
#,##0 |
5 |
-5 |
1 | |
|
#,##0.00;;;Nil |
5.00 |
-5.00 |
0.50 |
Nil |
|
$#,##0;($#,##0) |
$5 |
($5) |
$1 | |
|
$#,##0.00;($#,##0.00) |
$5.00 |
($5.00) |
$0.50 | |
|
0% |
500% |
-500% |
50% | |
|
0.00% |
500.00% |
-500.00% |
50.00% | |
|
0.00E+00 |
5.00E+00 |
-5.00E+00 |
5.00E-01 | |
|
0.00E-00 |
5.00E00 |
-5.00E00 |
5.00E-01 | |
A format expression for strings can have one section, or two sections separated by a semicolon.
|
If you use |
The result is |
|
One section only |
The format applies to all string data. |
|
Two sections |
The first section applies to string data, the second to Null values and zero-length strings. |
The following table identifies the predefined date and time format names:
|
Format Name |
Description |
|
General Date |
Display a date and/or time. For real numbers, display a date and time (for example, 4/3/93 05:34 PM); if there is no fractional part, display only a date (for example, 4/3/93); if there is no integer part, display time only (for example, 05:34 PM). Date display is determined by your system settings. |
|
Long Date |
Display a date according to your system's long date format. |
|
Medium Date |
Display a date using the medium date format appropriate for the language version of the host application. |
|
Short Date |
Display a date using your system's short date format. |
|
Long Time |
Display a time using your system's long time format: includes hours, minutes, seconds. |
|
Medium Time |
Display time in 12-hour format using hours and minutes and the AM/PM designator. |
|
Short Time |
Display a time using the 24-hour format (for example, 17:45). |
The following table identifies the predefined numeric format names:
|
Format name |
Description |
|
General Number |
Display number as is, with no thousand separators. |
|
Currency |
Display number with thousand separator, if appropriate; display negative numbers enclosed in parentheses; display two digits to the right of the decimal separator. Note that output is based on system settings. |
|
Fixed |
Display at least one digit to the left and two digits to the right of the decimal separator. |
|
Standard |
Display number with thousands separator, at least one digit to the left and two digits to the right of the decimal separator. |
|
Percent |
Display number multiplied by 100 with a percent sign (%) appended to the right; always displays two digits to the right of the decimal separator. |
|
Scientific |
Use standard scientific notation. |
|
Yes/No |
Display No if number is 0; otherwise, display Yes. |
|
True/False |
Display False if number is 0; otherwise, display True. |
|
On/Off |
Display Off if number is 0; otherwise, display On. |
The following table identifies characters you can use to create user-defined date/time formats:
|
Character |
Description |
|
: |
Time separator. In some locales, other characters may be used to represent the time separator. The time separator separates hours, minutes, and seconds when time values are formatted. The actual character used as the time separator in formatted output is determined by your system settings. |
|
/ |
Date separator. In some locales, other characters may be used to represent the date separator. The date separator separates the day, month, and year when date values are formatted. The actual character used as the date separator in formatted output is determined by your system settings. |
|
c |
Display the date as ddddd and display the time as t t t t t, in that order. Display only date information if there is no fractional part to the date serial number; display only time information if there is no integer portion. |
|
d |
Display the day as a number without a leading zero (1-31). |
|
dd |
Display the day as a number with a leading zero (01-31). |
|
ddd |
Display the day as an abbreviation (Sun-Sat). |
|
dddd |
Display the day as a full name (Sunday-Saturday). |
|
ddddd |
Display a date as a complete date (including day, month, and year), formatted according to your system's short date format setting. For Microsoft Windows, the default short date format is m/d/yy. |
|
dddddd |
Display a date serial number as a complete date (including day, month, and year) formatted according to the long date setting recognized by your system. For Microsoft Windows, the default long date format is mmmm dd, yyyy. |
|
w |
Display the day of the week as a number (1 for Sunday through 7 for Saturday). |
|
ww |
Display the week of the year as a number (1-53). |
|
m |
Display the month as a number without a leading zero (1-12). If m immediately follows h or hh, the minute rather than the month is displayed. |
|
mm |
Display the month as a number with a leading zero (01-12). If m immediately follows h or hh, the minute rather than the month is displayed. |
|
mmm |
Display the month as an abbreviation (Jan-Dec). |
|
mmmm |
Display the month as a full month name (January-December). |
|
q |
Display the quarter of the year as a number (1-4). |
|
y |
Display the day of the year as a number (1-366). |
|
yy |
Display the year as a 2-digit number (00-99). |
|
yyyy |
Display the year as a 4-digit number (100-9999). |
|
h |
Display the hour as a number without leading zeros (0-23). |
|
hh |
Display the hour as a number with leading zeros (00-23). |
|
n |
Display the minute as a number without leading zeros (0-59). |
|
nn |
Display the minute as a number with leading zeros (00-59). |
|
s |
Display the second as a number without leading zeros (0-59). |
|
ss |
Display the second as a number with leading zeros (00-59). |
|
t t t t t |
Display a time as a complete time (including hour, minute, and second), formatted using the time separator defined by the time format recognized by your system. A leading zero is displayed if the leading zero option is selected and the time is before 10:00 A.M. or P.M. The default time format is h:mm:ss. |
|
AM/PM |
Use the 12-hour clock and display an uppercase AM with any hour before noon; display an uppercase PM with any hour between noon and 11:59 P.M. |
|
am/pm |
Use the 12-hour clock and display a lowercase AM with any hour before noon; display a lowercase PM with any hour between noon and 11:59 P.M. |
|
A/P |
Use the 12-hour clock and display an uppercase A with any hour before noon; display an uppercase P with any hour between noon and 11:59 P.M. |
|
a/p |
Use the 12-hour clock and display a lowercase A with any hour before noon; display a lowercase P with any hour between noon and 11:59 P.M. |
|
AMPM |
Use the 12-hour clock and display the AM string literal as defined by your system with any hour before noon; display the PM string literal as defined by your system with any hour between noon and 11:59 P.M. AMPM can be either uppercase or lowercase, but the case of the string displayed matches the string as defined by your system settings. For Microsoft Windows, the default format is AM/PM. |
Examples
The following are examples of user-defined date and time formats for December 7, 1958:
|
Format |
Display |
|
m/d/yy |
12/7/58 |
|
d-mm |
7-Dec |
|
d-mmmm-yy |
7-December-58 |
|
d-mmmm |
7 December |
|
mmmm-yy |
December 58 |
|
hh:mm AM/PM |
08:50 PM |
|
h:mm:ss a/p |
8:50:35 p |
|
h:mm |
20:50 |
|
h:mm:ss |
20:50:35 |
|
m/d/yy h:mm |
12/7/58 20:50 |
The following table identifies characters you can use to create user-defined number formats:
|
Character |
Description |
|
None |
No formatting |
|
|
Display the number with no formatting. |
|
0 |
Digit placeholder |
|
Display a digit or a zero. If the expression has a digit in the position where the 0 appears in the format string, display it; otherwise, display a zero in that position. | |
|
If the number has fewer digits than there are zeros (on either side of the decimal) in the format expression, display leading or trailing zeros. If the number has more digits to the right of the decimal separator than there are zeros to the right of the decimal separator in the format expression, round the number to as many decimal places as there are zeros. If the number has more digits to the left of the decimal separator than there are zeros to the left of the decimal separator in the format expression, display the extra digits without modification. | |
|
# |
Digit placeholder |
|
Display a digit or nothing. If the expression has a digit in the position where the # appears in the format string, display it; otherwise, display nothing in that position. | |
|
This symbol works like the 0 digit placeholder, except that leading and trailing zeros aren't displayed if the number has the same or fewer digits than there are # characters on either side of the decimal separator in the format expression. | |
|
. |
Decimal placeholder |
|
In some locales, a comma is used as the decimal separator. The decimal placeholder determines how many digits are displayed to the left and right of the decimal separator. If the format expression contains only number signs to the left of this symbol, numbers smaller than 1 begin with a decimal separator. If you always want a leading zero displayed with fractional numbers, use 0 as the first digit placeholder to the left of the decimal separator instead. The actual character used as a decimal placeholder in the formatted output depends on the Number Format recognized by your system. | |
|
% |
Percentage placeholder |
|
The expression is multiplied by 100. The percent character (%) is inserted in the position where it appears in the format string. | |
|
, |
Thousand separator |
|
In some locales, a period is used as a thousand separator. The thousand separator separates thousands from hundreds within a number that has four or more places to the left of the decimal separator. Standard use of the thousand separator is specified if the format contains a thousand separator surrounded by digit placeholders (0 or #). Two adjacent thousand separators or a thousand separator immediately to the left of the decimal separator (whether or not a decimal is specified) means "scale the number by dividing it by 1000, rounding as needed." You can scale large numbers using this technique. For example, you can use the format string "##0,," to represent 100 million as 100. Numbers smaller than 1 million are displayed as 0. Two adjacent thousand separators in any position other than immediately to the left of the decimal separator are treated simply as specifying the use of a thousand separator. The actual character used as the thousand separator in the formatted output depends on the Number Format recognized by your system. | |
|
: |
Time separator |
|
In some locales, other characters may be used to represent the time separator. The time separator separates hours, minutes, and seconds when time values are formatted. The actual character used as the time separator in formatted output is determined by your system settings. | |
|
/ |
Date separator |
|
In some locales, other characters may be used to represent the date separator. The date separator separates the day, month, and year when date values are formatted. The actual character used as the date separator in formatted output is determined by your system settings. | |
|
E- E+ e- e+ |
Scientific format |
|
If the format expression contains at least one digit placeholder (0 or #) to the right of E-, E+, e-, or e+, the number is displayed in scientific format and E or e is inserted between the number and its exponent. The number of digit placeholders to the right determines the number of digits in the exponent. Use E- or e- to place a minus sign next to negative exponents. Use E+ or e+ to place a minus sign next to negative exponents and a plus sign next to positive exponents. | |
|
- + $ ( ) space |
Display a literal character |
|
To display a character other than one of those listed, precede it with a backslash (\) or enclose it in double quotation marks (" "). | |
|
\ |
Display the next character in the format string |
|
Many characters in the format expression have a special meaning and can't be displayed as literal characters unless they are preceded by a backslash. The backslash itself isn't displayed. Using a backslash is the same as enclosing the next character in double quotation marks. To display a backslash, use two backslashes (\\). | |
|
Examples of characters that can't be displayed as literal characters are the date- and time-formatting characters (a, c, d, h, m, n, p, q, s, t, w, y, and /:), the numeric-formatting characters (#, 0, %, E, e, comma, and period), and the string-formatting characters (@, &, <, >, and !). | |
|
"ABC" |
Display the string inside the double quotation marks |
|
To include a string in format from within code, you must use Chr(34) to enclose the text (34 is the character code for a double quotation mark). |
Example
Some sample format expressions for numbers are shown below. (These examples all assume that your system's locale setting is English-US.) The first column contains the format strings. The other columns contain the output that results if the formatted data has the value given in the column headings.
|
Format (format) |
Positive 5 |
Negative 5 |
Decimal .5 |
Null |
|
Zero-length string |
5 |
-5 |
0.5 | |
|
0 |
5 |
-5 |
1 | |
|
0.00 |
5.00 |
-5.00 |
0.50 | |
|
#,##0 |
5 |
-5 |
1 | |
|
#,##0.00;;;Nil |
5.00 |
-5.00 |
0.50 |
Nil |
|
$#,##0;($#,##0) |
$5 |
($5) |
$1 | |
|
$#,##0.00;($#,##0.00) |
$5.00 |
($5.00) |
$0.50 | |
|
0% |
500% |
-500% |
50% | |
|
0.00% |
500.00% |
-500.00% |
50.00% | |
|
0.00E+00 |
5.00E+00 |
-5.00E+00 |
5.00E-01 | |
|
0.00E-00 |
5.00E00 |
-5.00E00 |
5.00E-01 | |
You can use any of the following characters to create a format expression for strings:
|
Character |
Description |
|
@ |
Character placeholder Display a character or a space. If the string has a character in the position where the @ appears in the format string, display it; otherwise, display a space in that position. Placeholders are filled from right to left unless there is an ! character in the format string. See below. |
|
& |
Character placeholder Display a character or nothing. If the string has a character in the position where the & appears, display it; otherwise, display nothing. Placeholders are filled from right to left unless there is an ! character in the format string. See below. |
|
< |
Force lowercase Display all characters in lowercase format. |
|
> |
Force uppercase Display all characters in uppercase format. |
|
! |
Force left to right fill of placeholders The default is to fill from right to left. |