DatePicker.YearFormat Property

Reference

Definition

Namespace:: Microsoft.UI.Xaml.Controls

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

Gets or sets the display format for the year value.

public:
 property Platform::String ^ YearFormat { Platform::String ^ get(); void set(Platform::String ^ value); };

winrt::hstring YearFormat();

void YearFormat(winrt::hstring value);

public string YearFormat { get; set; }

var string = datePicker.yearFormat;
datePicker.yearFormat = string;

Public Property YearFormat As String

<DatePicker YearFormat="formatString"/>

Property Value

String

Platform::String

winrt::hstring

The display format for the year value.

Examples

Here's a DatePicker formatted using format templates, and a DatePicker formatted using format strings. Both DatePickers look the same when the app is run because the formatting is equivalent.

<!-- DatePicker formatted using format templates. -->
<DatePicker DayFormat="day" MonthFormat="month.numeric" YearFormat="year.abbreviated"/>

<!-- DatePicker formatted using format patterns. -->
<DatePicker DayFormat="{}{day.integer}" MonthFormat="{}{month.integer}" YearFormat="{}{year.abbreviated}"/>

A date picker with its fields formatted.

Remarks

Change the format of the year picker by setting the YearFormat property.

The string content of each ComboBox in the DatePicker is created by a DateTimeFormatter. You inform the DateTimeFormatter how to format the year value by providing a string that is either a format template or a format pattern. Common templates and patterns for year values are listed in the following table.

format pattern	format template
`{year.full} \| {year.abbreviated} \| {year.abbreviated(n)}`	`year \| year.full \| year.abbreviated`
`{era.full} \| {era.abbreviated} \| {era.abbreviated(n)}`	n/a

Note

"Era" only applies when the CalendarIdentifier is set to the Japanese calendar. For the Japanese calendar, era is shown in the year picker.

For the complete list of format templates and format patterns, see the Remarks section of the DateTimeFormatter class documentation.

Note

Some date formats should be avoided if the date picker might be displayed in a small area, such as adding the full string value of the day of week. These strings can be long and might be clipped if the DatePicker's width is forced to be small.

Applies to