XFA Specification
Chapter 23, FormCalc Specification
Date And Time Built-in Functions
855
TimeFmt()
This function returns a
time format
given a time format style.
Syntax
TimeFmt([n1[, k1]]])
Parameters
n1
is an integer identifying the time format style, whose value has the following meaning:
n1
0
1
2
3
4
Style requested for the localized time format
Locale-specific default style
Locale-specific short style
Locale-specific medium style
Locale-specific long style
Locale-specific full style
If n1 is omitted, the default style value 0 is used.
k1
is a locale identifier string, as described in
“Specifying a Locale (Locale Identifier String)” on
If k1 is omitted, the
prevailing locale
Returns
The
time format
or null if any of its parameters are null.
If the given format style is invalid, the function returns default-style time format.
Examples
Calling TimeFmt() as follows …
TimeFmt()
TimeFmt(1)
TimeFmt(2, "fr_CA")
TimeFmt(4, "de_DE")
Returns
"h:MM:SS A"
"h:MM A"
"HH:MM:SS"
"H.MM' Uhr 'Z"
See Also
Time()
.