Format

Format

This function formats a string in the specified format pattern and locale.

Format patterns follow the C# format types outlined in the official Microsoft documentation:

• Standard Numeric Format Strings
• Standard Date and Time Format Strings

Some of these custom formats are supported:

• Custom Numeric Format Strings
• Custom Date and Time Format Strings

Arguments

Format(1,2,3,4)

Here are a few examples of format patterns, given a date of 2017-09-15T06:07:08.1230000-06:00:

NOTE: This function returns lowercase month and day names for non-US culture codes by default.

Here are a few examples of format patterns, given a number of -0.8967:

Here are a few examples of custom format patterns, given a number of -1.8967:

Example 1

The following examples illustrate the base date and time formats:

%%[

var @dateString, @timeString, @long, @short, @fullShortTime, @fullShortTimeFR, @fullLongTime, @generalShortTime, @generalLongTime, @monthDay, @roundTrip, @RFC1123, @sortable, @shortTime, @longTime, @universalSortable, @universalFull, @monthYear, @monthNumber, @monthShortName, @monthFullName, @dayNumber, @dayFullName, @hour, @minute, @seconds, @AMPM, @offsetHours, @offsetHoursMinutes

set @dateString = "2017-09-15T06:07:08.1230000-06:00"
set @timeString = "06:07:08.123 AM"

set @long = Format(@dateString,"D", "Date")
set @short = Format(@dateString,"d", "Date")
set @fullShortTime = Format(@dateString,"f", "Date")
set @fullShortTimeFR = ProperCase(Format(@dateString,"f", "Date","fr-FR"))
set @fullLongTime = Format(@dateString,"F", "Date")
set @generalShortTime = Format(@dateString,"g", "Date")
set @generalLongTime = Format(@dateString,"G", "Date")
set @monthDay = Format(@dateString,"M", "Date")
set @roundTrip = Format(@dateString,"O", "Date")
set @RFC1123 = Format(@dateString,"R", "Date")
set @sortable = Format(@dateString,"s", "Date")
set @shortTime = Format(@dateString,"t", "Date")
set @longTime = Format(@dateString,"T", "Date")
set @universalSortable = Format(@dateString,"u", "Date")
set @universalFull = Format(@dateString,"U", "Date")
set @monthYear = Format(@dateString,"Y", "Date")

set @monthNumber = Format(@dateString,"MM","Date")
set @monthShortName = Format(@dateString,"MMM","Date")
set @monthFullName = Format(@dateString,"MMMM","Date")

set @dayNumber = Format(@dateString,"dd","Date")
set @dayShortName = Format(@dateString,"ddd","Date")
set @dayFullName = Format(@dateString,"ddddd","Date")

set @hour = Format(@timeString,"hh","Date")
set @minute = Format(@timeString,"mm","Date")
set @seconds = Format(@timeString, "ss","Date")
set @AMPM = Format(@timeString,"tt","Date")
set @offsetHours = Format(@dateString,"zz","Date")
set @offsetHoursMinutes = Format(@dateString,"zzz","Date")

]%%
dateString: %%=v(@dateString)=%%
<br><br>long: %%=v(@long)=%%
<br>short: %%=v(@short)=%%
<br>fullShortTime: %%=v(@fullShortTime)=%%
<br>fullShortTimeFR: %%=v(@fullShortTimeFR)=%%
<br>fullLongTime: %%=v(@fullLongTime)=%%
<br>generalShortTime: %%=v(@generalShortTime)=%%
<br>generalLongTime: %%=v(@generalLongTime)=%%
<br>monthDay: %%=v(@monthDay)=%%
<br>roundTrip: %%=v(@roundTrip)=%%
<br>RFC1123: %%=v(@RFC1123)=%%
<br>sortable: %%=v(@sortable)=%%
<br>shortTime: %%=v(@shortTime)=%%
<br>longTime: %%=v(@longTime)=%%
<br>universalSortable: %%=v(@universalSortable)=%%
<br>universalFull: %%=v(@universalFull)=%%
<br>monthYear: %%=v(@monthYear)=%%
<br><br>monthNumber: %%=v(@monthNumber)=%%
<br>monthShortName: %%=v(@monthShortName)=%%
<br>monthFullName: %%=v(@monthFullName)=%%
<br>dayNumber: %%=v(@dayNumber)=%%
<br>dayShortName: %%=v(@dayShortName)=%%
<br>dayFullName: %%=v(@dayFullName)=%%
<br><br>timeString: %%=v(@timeString)=%%
<br>hour: %%=v(@hour)=%%
<br>minute: %%=v(@minute)=%%
<br>seconds: %%=v(@seconds)=%%
<br>AMPM: %%=v(@AMPM)=%%
<br>offsetHours: %%=v(@offsetHours)=%%
<br>offsetHoursMinutes: %%=v(@offsetHoursMinutes)=%%

Output

dateString: 2017-09-15T06:07:08.1230000-06:00

long: Friday, September 15, 2017
short: 9/15/2017
fullShortTime: Friday, September 15, 2017 6:07 AM
fullShortTimeFR: Vendredi 15 Septembre 2017 06:07
fullLongTime: Friday, September 15, 2017 6:07:08 AM
generalShortTime: 9/15/2017 6:07 AM
generalLongTime: 9/15/2017 6:07:08 AM
monthDay: September 15
roundTrip: 2017-09-15T06:07:08.1230000-06:00
RFC1123: Fri, 15 Sep 2017 06:07:08 GMT
sortable: 2017-09-15T06:07:08
shortTime: 6:07 AM
longTime: 6:07:08 AM
universalSortable: 2017-09-15 06:07:08Z
universalFull: Friday, September 15, 2017 12:07:08 PM
monthYear: September 2017

monthNumber: 09
monthShortName: Sep
monthFullName: September
dayNumber: 15
dayShortName: Fri
dayFullName: Friday

timeString: 06:07:08.123 AM
hour: 06
minute: 07
seconds: 08
AMPM: AM
offsetHours: -06
offsetHoursMinutes: -06:00

Example 2

The following examples illustrate some common number formats:

Example 3

The following examples illustrate some custom number formats:

Example 4

The following examples illustrate some common date formats:

Example 5

The following examples illustrate some common phone formats: