DateTimeFormatter Class

Definition

Namespace:: Windows.Globalization.DateTimeFormatting

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Formats dates and times.

public ref class DateTimeFormatter sealed

/// [Windows.Foundation.Metadata.Activatable(Windows.Globalization.DateTimeFormatting.IDateTimeFormatterFactory, 65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class DateTimeFormatter final

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.Activatable(Windows.Globalization.DateTimeFormatting.IDateTimeFormatterFactory, 65536, "Windows.Foundation.UniversalApiContract")]
class DateTimeFormatter final

[Windows.Foundation.Metadata.Activatable(typeof(Windows.Globalization.DateTimeFormatting.IDateTimeFormatterFactory), 65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class DateTimeFormatter

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Activatable(typeof(Windows.Globalization.DateTimeFormatting.IDateTimeFormatterFactory), 65536, "Windows.Foundation.UniversalApiContract")]
public sealed class DateTimeFormatter

function DateTimeFormatter(yearFormat, monthFormat, dayFormat, dayOfWeekFormat, hourFormat, minuteFormat, secondFormat, languages, geographicRegion, calendar, clock)

Public NotInheritable Class DateTimeFormatter

Inheritance: Object Platform::Object IInspectable DateTimeFormatter

Attributes: ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Requirements	Description
Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

Examples

Use the DateTimeFormatter class to format a date.

// Format a date via a string template. Note that the order specifed in the string pattern does
// not determine the order of the parts of the formatted string. The user's language and region
// preferences will determine the pattern of the date returned based on the specified parts.

var formatter = new Windows.Globalization.DateTimeFormatting.DateTimeFormatter("month day dayofweek year");
DateTime dateToFormat = DateTime.Now;
var mydate = formatter.Format(dateToFormat);

Pattern grammarThe following grammar defines what is accepted for a pattern:

 ::= []  [] |
              []  

 ::= +

 ::= [^{}] | "{openbrace}" | "{closebrace}"

 ::=  | 

 ::=  |  |  |  | 

 ::=  |  |  |  | 

 ::= "{era.abbreviated" [] "}"

 ::= "{year.full" [] "}" |
           "{year.abbreviated" [] "}"

 ::= "{month.full}" |
            "{month.solo.full}" |
            "{month.abbreviated" [] "}"
            "{month.solo.abbreviated" [] "}"
            "{month.integer" [] "}"

 ::= "{dayofweek.full}" |
                "{dayofweek.solo.full}" |
                "{dayofweek.abbreviated" [] "}"
                "{dayofweek.solo.abbreviated" [] "}"

 ::= "{day.integer" [] "}"

 ::= "{period.abbreviated" [] "}"

 ::= "{hour.integer" [] "}"

 ::= "{minute.integer" [] "}"

 ::= "{second.integer" [] "}"

 ::= "{timezone.full}" |
                "{timezone.abbreviated" [] "}"

 ::= "("  ")"

 ::= "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9"

Template grammarThe following grammar defines what is accepted for a template:

Template	Language	Clock	Output	Equivalent pattern
longdate	en-US		‎Monday‎, ‎September‎ ‎2‎, ‎2013	‎{dayofweek.full}‎, ‎{month.full}‎ ‎{day.integer}‎, ‎{year.full}
longdate	fr-FR		lundi‎ ‎2‎ ‎septembre‎ ‎2013	{dayofweek.full}‎ ‎{day.integer}‎ ‎{month.full}‎ ‎{year.full}
shortdate	en-US		9‎/‎2‎/‎2013	{month.integer}‎/‎{day.integer}‎/‎{year.full}
shortdate	fr-FR		02‎/‎09‎/‎2013	‎{day.integer(2)}‎/‎{month.integer(2)}‎/‎{year.full}
dayofweek month day	en-US		‎Monday‎, ‎September‎ ‎2	{dayofweek.full}‎, ‎{month.full}‎ ‎{day.integer}
month day dayofweek	en-US		‎Monday‎, ‎September‎ ‎2	{dayofweek.full}‎, ‎{month.full}‎ ‎{day.integer}
longtime	en-US		‎6‎:‎01‎:‎24‎ ‎AM	{hour.integer}‎:‎{minute.integer(2)}‎:‎{second.integer(2)}‎ ‎{period.abbreviated}
longtime	en-US	24HourClock	‎17‎:‎32‎:‎45	{hour.integer}‎:‎{minute.integer(2)}‎:‎{second.integer(2)}
longtime	fr-FR		17‎:‎32‎:‎45	{hour.integer(2)}‎:‎{minute.integer(2)}‎:‎{second.integer(2)}
shorttime	en-US		6‎:‎01‎ ‎AM	{hour.integer}‎:‎{minute.integer(2)}‎ ‎{period.abbreviated}
shorttime	en-US	24HourClock	17‎:‎32	‎{hour.integer}‎:‎{minute.integer(2)}
shorttime	fr-FR		17‎:‎32	‎{hour.integer(2)}‎:‎{minute.integer(2)}

Pattern	Language	Clock	Output
{dayofweek.full}, ‎{month.full} {day.integer}, ‎{year.full}	en-US		Monday, ‎September 2, ‎2013
{dayofweek.full}, ‎{day.integer(2)} ‎{month.full}, ‎{year.full}	fr-FR		lundi, ‎02 ‎septembre, ‎2013
{month.integer}/‎{day.integer}/{year.full}	en-US		9/‎2/2013
{month.integer}/‎{day.integer}/{year.abbreviated}	en-US		9/‎2/13
{month.integer(2)}/‎{day.integer(2)}/{year.abbreviated}	en-US		09/‎02/13
{hour.integer}:{minute.integer(2)}:{second.integer(2)} {period.abbreviated}	en-US		6:01:24 AM
{hour.integer}:{minute.integer(2)}:{second.integer(2)} {period.abbreviated}	en-US	24HourClock	17:32:45

Name	Description
DateTimeFormatter(HourFormat, MinuteFormat, SecondFormat)	Creates a DateTimeFormatter object that is initialized with hour, minute, and second formats.
DateTimeFormatter(String, IIterable, String, String, String)	Creates a DateTimeFormatter object that is initialized by a format template string, language list, geographic region, calendar, and clock.
DateTimeFormatter(String, IIterable)	Creates a DateTimeFormatter object that is initialized by a format template string and language list.
DateTimeFormatter(String)	Creates a DateTimeFormatter object that is initialized by a format template string.
DateTimeFormatter(YearFormat, MonthFormat, DayFormat, DayOfWeekFormat, HourFormat, MinuteFormat, SecondFormat, IIterable, String, String, String)	Creates a DateTimeFormatter object with all formats and identifiers specified.
DateTimeFormatter(YearFormat, MonthFormat, DayFormat, DayOfWeekFormat, HourFormat, MinuteFormat, SecondFormat, IIterable)	Creates a DateTimeFormatter object that is initialized with year, month, day, day of week, hour, minute, and second formats, and a language list.
DateTimeFormatter(YearFormat, MonthFormat, DayFormat, DayOfWeekFormat)	Creates a DateTimeFormatter object that is initialized with year, month, day, and day of week formats.

Name	Description
Calendar	Gets the calendar that is used when formatting dates.
Clock	Gets the clock that is used when formatting times.
GeographicRegion	Gets or sets the region that is used when formatting dates and times.
IncludeDay	Gets the DayFormat in the template.
IncludeDayOfWeek	Gets the DayOfWeekFormat in the template.
IncludeHour	Gets the HourFormat in the template.
IncludeMinute	Gets the MinuteFormat in the template.
IncludeMonth	Gets the MonthFormat in the template.
IncludeSecond	Gets the SecondFormat in the template.
IncludeYear	Gets the YearFormat in the template.
Languages	Gets the priority list of language identifiers that is used when formatting dates and times.
LongDate	Gets the DateTimeFormatter object that formats dates according to the user's choice of long date pattern.
LongTime	Gets the DateTimeFormatter object that formats times according to the user's choice of long time pattern.
NumeralSystem	Gets or sets the numbering system that is used to format dates and times.
Patterns	Gets the patterns corresponding to this template that are used when formatting dates and times.
ResolvedGeographicRegion	Gets the geographic region that was most recently used to format dates and times.
ResolvedLanguage	Gets the language that was most recently used to format dates and times.
ShortDate	Gets the DateTimeFormatter object that formats dates according to the user's choice of short date pattern.
ShortTime	Gets the DateTimeFormatter object that formats times according to the user's choice of short time pattern.
Template	Gets a string representation of this format template.

Name	Description
Format(DateTime, String)	Returns a string that represents the given date and time in the given time zone, conforming to the template the formatter is currently using.
Format(DateTime)	Returns a string representation of the provided date and time.

DateTimeFormatter Class

Definition

Windows requirements

Examples

Remarks

Constructors

Properties

Methods

Applies to

See also

Feedback

Format pattern field
{openbrace}
{closebrace}
{dayofweek.solo.} where is full / abbreviated / abbreviated(n)
{dayofweek.} where is full / abbreviated / abbreviated(n)
{day.} where is integer / integer(n)
{month.} where is full / abbreviated / abbreviated(n) / integer / integer(n)
{month.solo.} where is full / abbreviated / abbreviated(n)
{year.} where is full / abbreviated / abbreviated(n)
{era.} where is full / abbreviated / abbreviated(n)
{hour.} where is integer / integer(n)
{period.} where is full / abbreviated / abbreviated(n)
{minute.} where is integer / integer(n)
{second.} where is integer / integer(n)
{timezone.} where is full / abbreviated / abbreviated(n)