DateTimeFormatter class

Formats dates and times.

Syntax

var dateTimeFormatter = new Windows.Globalization.DateTimeFormatting.DateTimeFormatter(string);
var dateTimeFormatter = new Windows.Globalization.DateTimeFormatting.DateTimeFormatter(string, iIterable(String);
var dateTimeFormatter = new Windows.Globalization.DateTimeFormatting.DateTimeFormatter(string, iIterable(String);
var dateTimeFormatter = new Windows.Globalization.DateTimeFormatting.DateTimeFormatter(yearFormat, monthFormat, dayFormat, dayOfWeekFormat);
var dateTimeFormatter = new Windows.Globalization.DateTimeFormatting.DateTimeFormatter(hourFormat, minuteFormat, secondFormat);
var dateTimeFormatter = new Windows.Globalization.DateTimeFormatting.DateTimeFormatter(yearFormat, monthFormat, dayFormat, dayOfWeekFormat, hourFormat, minuteFormat, secondFormat, iIterable(String);
var dateTimeFormatter = new Windows.Globalization.DateTimeFormatting.DateTimeFormatter(yearFormat, monthFormat, dayFormat, dayOfWeekFormat, hourFormat, minuteFormat, secondFormat, iIterable(String);

Attributes

ActivatableAttribute(Windows.Globalization.DateTimeFormatting.IDateTimeFormatterFactory, NTDDI_WIN8)

DualApiPartitionAttribute()

MarshalingBehaviorAttribute(Agile)

StaticAttribute(Windows.Globalization.DateTimeFormatting.IDateTimeFormatterStatics, NTDDI_WIN8)

ThreadingAttribute(Both)

VersionAttribute(NTDDI_WIN8)

Members

The DateTimeFormatter class has these types of members:

• Constructors
• Methods
• Properties

Constructors

The DateTimeFormatter class has these constructors.

Methods

The DateTimeFormatter class has these methods. With C#, Visual Basic, and C++, it also inherits methods from the Object class.

Properties

The DateTimeFormatter class has these properties.

Remarks

Note  If your app passes language tags used in this class to any National Language Support functions, it must first convert the tags by calling ResolveLocaleName.

Some of the constructors for DateTimeFormatter take a formatTemplate string parameter that specifies the requested components to be formatted. This parameter can be either a format template or a format pattern.

Format templates are strings that specify common date and time patterns. Valid templates are listed in the following table. In templates with more than one component, the component may be any of the supported component variations and the components may be in any order. For example, "dayofweek.full year month.numeric day" is supported.

Format patterns are composed of a literal string with fields delimited by braces, such as "{day.numeric}/{month.numeric}/{year.full}". Valid fields are:

Note  

• Use {openbrace} or {closebrace} to specify that "{" or "}" appears as part of the literal string.
• solo specifies the standalone form. For languages with genitive case distinctions, the genitive case is the unmarked case. To get the nominative case, use solo.
• integer(2) for the fifth day of the month (for example) is "05", while integer(1) produces "5". integer produces the best n for a given language/calendar combination.
• For years, full produces all digits ("2013"). abbreviated is synonymous with abbreviated(2), which is the 2-digit year for the gregorian calendar ("13"). (Other calendars may eventually use something else as the default; we have kept abbreviated to have the semantics of the best for a given language/calendar combination.) abbreviated(n) is truncated to the least significant n digits (for example, 2013 with n=1 is "3").

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 mydatefmt = new Windows.Globalization.DateTimeFormatting.DateTimeFormatter("month day dayofweek year");
var dateToFormat = new Date();
var mydate = mydatefmt.format(dateToFormat);

Requirements

See also

Date and time formatting sample

Build date: 12/4/2012