Skip to main content
DateTimeFormatter.DateTimeFormatter(String, IIterable(String), String, String, String) constructor

Applies to Windows and Windows Phone

Creates a DateTimeFormatter object that is initialized by a format template string, language list, geographic region, calendar, and clock.

Syntax


var dateTimeFormatter = new Windows.Globalization.DateTimeFormatting.DateTimeFormatter(formatTemplate, languages, geographicRegion, calendar, clock);

public DateTimeFormatter(
  string formatTemplate, 
  IEnumerable<string> languages, 
  string geographicRegion, 
  string calendar, 
  string clock
)

Public Sub New (
  formatTemplate As String,  
  languages As IEnumerable(Of String),  
  geographicRegion As String,  
  calendar As String,  
  clock As String 
)

public:
DateTimeFormatter(
  String^ formatTemplate, 
  IIterable<String^>^ languages, 
  String^ geographicRegion, 
  String^ calendar, 
  String^ clock
)

Parameters

formatTemplate

Type: String [JavaScript] | System.String [.NET] | Platform::String [C++]

A format template string that specifies the requested components. The order of the components is irrelevant. This can also be a format pattern. See the remarks for the DateTimeFormatter class for a list of valid format templates and format patterns.

languages

Type: IIterable<String> [JavaScript/C++] | System.Collections.Generic.IEnumerable<String> [.NET]

The list of language identifiers, in priority order, that represent the choice of languages. These identifiers are used for resolving the template to a pattern, and for formatting. See Remarks.

geographicRegion

Type: String [JavaScript] | System.String [.NET] | Platform::String [C++]

The identifier for the geographic region. This identifier is used for resolving the template to a pattern.

calendar

Type: String [JavaScript] | System.String [.NET] | Platform::String [C++]

The calendar identifier to use.

clock

Type: String [JavaScript] | System.String [.NET] | Platform::String [C++]

The clock identifier to use.

Remarks

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.

Starting in Windows 8.1: Language tags support the Unicode extensions "ca-" and "nu-". (See Unicode Key/Type Definitions.) Note that the "ca-" extension can affect the calendar used by DateTimeFormatter objects.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.Globalization.DateTimeFormatting
Windows::Globalization::DateTimeFormatting [C++]

Metadata

Windows.winmd

See also

DateTimeFormatter
DateTimeFormatter(String)
DateTimeFormatter(YearFormat, MonthFormat, DayFormat, DayOfWeekFormat)
DateTimeFormatter(HourFormat, MinuteFormat, SecondFormat)
DateTimeFormatter(YearFormat, MonthFormat, DayFormat, DayOfWeekFormat, HourFormat, MinuteFormat, SecondFormat, IIterable, String, String, String)
Date and time formatting sample
Unicode Key/Type Definitions