DateTimeFormatting

page_type	languages	products	urlFragment	extendedZipContent	description
sample	csharp cpp cppcx cppwinrt	windows windows-uwp	DateTimeFormatting	path target SharedContent SharedContent path target LICENSE LICENSE	Shows how to use the DateTimeFormatter to display dates and times according to the user's preferences.

Date and time formatting sample

Shows how to use the DateTimeFormatter class in the Windows.Globalization.DateTimeFormatting namespace to display dates and times according to the user's preferences.

Note: This sample is part of a large collection of UWP feature samples. You can download this sample as a standalone ZIP file from docs.microsoft.com, or you can download the entire collection as a single ZIP file, but be sure to unzip everything to access shared dependencies. For more info on working with the ZIP file, the samples collection, and GitHub, see Get the UWP samples from GitHub. For more samples, see the Samples portal on the Windows Dev Center.

The DateTimeFormatter class provides a globally-aware method for formatting a date or time into a string for display to a user. It can either use the default preferences of the current user, or the caller can override these to specify other languages, geographic region, and clock and calendar systems. The caller can request a format using the well-known constants (shorttime, longtime, shortdate or longdate) or define the specific elements required.

The sample also uses the Windows.Globalization.CalendarIdentifiers and Windows.Globalization.ClockIdentifiers classes.

This sample contains scenarios that demonstrate:

• How to format the current date and time using the Long and Short formats.
• How to format the current date and time using custom formats that are specified using a template string or a parameterized template.
• How to format dates and times by overriding the user's default global context. This is used when an app presents dates or times that reflect different settings from the user's current defaults.
• How to format dates and times by using Unicode extensions in specified languages, overriding the user's default global context if applicable.
• How to convert and format the current date and time using the time zone support available in the Format method.

Related topics

Reference

Windows.Globalization.CalendarIdentifiers
Windows.Globalization.ClockIdentifiers
Windows.Globalization.DateTimeFormatting.DateTimeFormatter

Related samples

• Calendar sample
• GlobalizationPreferences sample
• NumberFormatting sample
• DateTimeFormatting sample for JavaScript (archived)

System requirements

• Windows 10

Build the sample

1. If you download the samples ZIP, be sure to unzip the entire archive, not just the folder with the sample you want to build.
2. Start Microsoft Visual Studio and select File > Open > Project/Solution.
3. Starting in the folder where you unzipped the samples, go to the Samples subfolder, then the subfolder for this specific sample, then the subfolder for your preferred language (C++, C#, or JavaScript). Double-click the Visual Studio Solution (.sln) file.
4. Press Ctrl+Shift+B, or select Build > Build Solution.

Run the sample

The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it.

Deploying the sample

• Select Build > Deploy Solution.

Deploying and running the sample

• To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or select Debug > Start Without Debugging.