DateTimeOffset::ToString Method (IFormatProvider^)


Converts the value of the current DateTimeOffset object to its equivalent string representation using the specified culture-specific formatting information.

Namespace:   System
Assembly:  mscorlib (in mscorlib.dll)

String^ ToString(
	IFormatProvider^ formatProvider


Type: System::IFormatProvider^

An object that supplies culture-specific formatting information.

Return Value

Type: System::String^

A string representation of the value of the current DateTimeOffset object, as specified by formatProvider.

Exception Condition

The date and time is outside the range of dates supported by the calendar used by formatProvider.

The return value of this method is identical to that of its equivalent overload of the DateTime::ToString method, except that it includes a space followed by the offset appended at the end of the string. In other words, it formats output using the short date pattern, the long time pattern, and the zzz custom format string, with each element separated from the previous element by a space.

The format of these three elements is defined by the formatProvider parameter. The formatProvider parameter can be either of the following:

If formatProvider is null, the DateTimeFormatInfo object associated with the current culture is used (see CurrentCulture).

Notes to Callers:

The ToString(IFormatProvider^) method returns the string representation of the date and time in the calendar used by the culture represented by the formatProvider parameter. Its calendar is defined by the Calendar property. If the value of the current DateTimeOffset instance is earlier than Calendar::MinSupportedDateTime or later than Calendar::MaxSupportedDateTime, the method throws an ArgumentOutOfRangeException. The following example provides an illustration. It attempts to format a date that is outside the range of the JapaneseCalendar class.

No code example is currently available or this language may not be supported.

The following example displays a DateTimeOffset object using CultureInfo objects that represent the invariant culture, as well as four other cultures.

No code example is currently available or this language may not be supported.

Universal Windows Platform
Available since 8
.NET Framework
Available since 2.0
Portable Class Library
Supported in: portable .NET platforms
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top