DateTimeZone.ToText
Syntax
DateTimeZone.ToText(dateTimeZone as nullable datetimezone, optional options as any, optional culture as nullable text) as nullable text
About
Returns a textual representation of dateTimeZone
. An optional record
parameter, options
, may be provided to specify additional properties. culture
is only used for legacy workflows. The record
can contain the following fields:
Format
: Atext
value indicating the format to use. For more details, go to * Standard date and time format strings and Custom date and time format strings. Omitting this field or providingnull
will result in formatting the date using the default defined byCulture
.Culture
: WhenFormat
is not null,Culture
controls some format specifiers. For example, in"en-US"
"MMM"
is"Jan", "Feb", "Mar", ...
, while in"ru-RU"
"MMM"
is"янв", "фев", "мар", ...
. WhenFormat
isnull
,Culture
controls the default format to use. WhenCulture
isnull
or omitted, Culture.Current is used.
To support legacy workflows, options
and culture
may also be text values. This has the same behavior as if options = [Format = options, Culture = culture]
.
Example 1
Convert #datetimezone(2010, 12, 31, 01, 30, 25, 2, 0)
into a text
value. Result output may vary depending on current culture.
Usage
DateTimeZone.ToText(#datetimezone(2010, 12, 31, 01, 30, 25, 2, 0))
Output
"12/31/2010 1:30:25 AM +02:00"
Example 2
Convert using a custom format and the German culture.
Usage
DateTimeZone.ToText(#datetimezone(2010, 12, 30, 2, 4, 50.36973, -8,0), [Format="dd MMM yyyy HH:mm:ss.ffffff zzz", Culture="de-DE"])
Output
"30 Dez 2010 02:04:50.369730 -08:00"
Example 3
Convert using the ISO 8601 pattern.
Usage
DateTimeZone.ToText(#datetimezone(2000, 2, 8, 3, 45, 12, 2, 0),[Format="O", Culture="en-US"])
Output
"2000-02-08T03:45:12.0000000+02:00"