DateTimeOffset.ToString メソッド

リファレンス

定義

名前空間:: System

アセンブリ:: System.Runtime.dll

アセンブリ:: mscorlib.dll

アセンブリ:: netstandard.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

現在の DateTimeOffset オブジェクトの値を等価の文字列形式に変換します。

オーバーロード

ToString()	現在の DateTimeOffset オブジェクトの値を等価の文字列形式に変換します。
ToString(IFormatProvider)	指定したカルチャ固有の書式設定情報を使用して、現在の DateTimeOffset オブジェクトの値を等価の文字列形式に変換します。
ToString(String)	指定した形式を使用して、現在の DateTimeOffset オブジェクトの値を等価の文字列形式に変換します。
ToString(String, IFormatProvider)	現在の DateTimeOffset オブジェクトの値を、指定した書式およびカルチャ固有の書式情報を使用して、等価の文字列形式に変換します。

ToString()

ソース:: DateTimeOffset.cs

ソース:: DateTimeOffset.cs

ソース:: DateTimeOffset.cs

現在の DateTimeOffset オブジェクトの値を等価の文字列形式に変換します。

public:
 override System::String ^ ToString();

public override string ToString ();

override this.ToString : unit -> string

Public Overrides Function ToString () As String

戻り値

String

文字列の末尾に追加されたオフセットを含む DateTimeOffset オブジェクトの文字列形式。

例外

ArgumentOutOfRangeException

日付と時刻が、現在のカルチャで使用されているカレンダーでサポートされている日付の範囲外です。

例

次の例は、ToString() メソッドの呼び出しを示し、現在のカルチャが en-usされているシステムに出力を表示します。

DateTimeOffset thisDate;

// Show output for UTC time
thisDate = DateTimeOffset.UtcNow;
Console.WriteLine(thisDate.ToString());  // Displays 3/28/2007 7:13:50 PM +00:00

// Show output for local time
thisDate = DateTimeOffset.Now;
Console.WriteLine(thisDate.ToString());  // Displays 3/28/2007 12:13:50 PM -07:00

// Show output for arbitrary time offset
thisDate = thisDate.ToOffset(new TimeSpan(-5, 0, 0));
Console.WriteLine(thisDate.ToString());  // Displays 3/28/2007 2:13:50 PM -05:00

// Show output for UTC time
let thisDate = DateTimeOffset.UtcNow
printfn $"{thisDate.ToString()}"  // Displays 3/28/2007 7:13:50 PM +00:00

// Show output for local time
let thisDate = DateTimeOffset.Now
printfn $"{thisDate.ToString()}"  // Displays 3/28/2007 12:13:50 PM -07:00

// Show output for arbitrary time offset
let thisDate = thisDate.ToOffset(TimeSpan(-5, 0, 0))
printfn $"{thisDate.ToString()}"  // Displays 3/28/2007 2:13:50 PM -05:00

Dim thisDate As DateTimeOffset

' Show output for UTC time
thisDate = DateTimeOffset.UtcNow
Console.WriteLine(thisDate.ToString())  ' Displays 3/28/2007 7:13:50 PM +00:00

' Show output for local time 
thisDate = DateTimeOffset.Now
Console.WriteLine(thisDate.ToString())  ' Displays 3/28/2007 12:13:50 PM -07:00

' Show output for arbitrary time offset
thisDate = thisDate.ToOffset(new TimeSpan(-5, 0, 0))
Console.WriteLine(thisDate.ToString())  ' Displays 3/28/2007 2:13:50 PM -05:00

注釈

このメソッドの戻り値は、DateTime.ToString() メソッドの戻り値と同じですが、スペースの後に文字列の末尾に追加されたオフセットが含まれている点が異なります。つまり、短い日付パターン、長い時間パターン、およびカスタム書式指定文字列 zzz を使用して出力を書式設定し、各要素をスペースで区切ります。たとえば、DateTime.ToString() が 2008 年 6 月 12 日午後 6 時 15 分 50 分の値を返す場合、ToString() は協定世界時 (UTC) から 8 時間遅れている時刻の 2008 年 1 月 12 日午後 6:15:50 -08:00 の値を返します。

このメソッドは、現在のカルチャから派生した書式設定情報を使用します。詳細については、CurrentCultureを参照してください。 ToString メソッドのその他のオーバーロードを使用すると、書式設定を使用するカルチャを指定し、DateTimeOffset 値の出力パターンを定義できます。

注意 (呼び出し元)

ToString() メソッドは、現在のカルチャで使用されているカレンダーの日付と時刻の文字列形式を返します。現在の DateTimeOffset インスタンスの値が MinSupportedDateTime より前または MaxSupportedDateTimeより後の場合、メソッドは ArgumentOutOfRangeExceptionをスローします。次の例では、図を示します。現在のカルチャがアラビア語 (シリア) の場合、HijriCalendar クラスの範囲外の日付を書式設定しようとします。

using System;
using System.Globalization;
using System.Threading;

public class Example
{
   public static void Main()
   {
      DateTimeOffset date1 = new DateTimeOffset(new DateTime(550, 1, 1),
                                                TimeSpan.Zero);
      CultureInfo dft;
      CultureInfo arSY = new CultureInfo("ar-SY");
      arSY.DateTimeFormat.Calendar = new HijriCalendar();

      // Change current culture to ar-SY.
      dft = Thread.CurrentThread.CurrentCulture;
      Thread.CurrentThread.CurrentCulture = arSY;

      // Display the date using the current culture's calendar.
      try {
         Console.WriteLine(date1.ToString());
      }
      catch (ArgumentOutOfRangeException) {
         Console.WriteLine("{0} is earlier than {1} or later than {2}",
                           date1.ToString("d", CultureInfo.InvariantCulture),
                           arSY.DateTimeFormat.Calendar.MinSupportedDateTime.ToString("d", CultureInfo.InvariantCulture),
                           arSY.DateTimeFormat.Calendar.MaxSupportedDateTime.ToString("d", CultureInfo.InvariantCulture));
      }

      // Restore the default culture.
      Thread.CurrentThread.CurrentCulture = dft;
   }
}
// The example displays the following output:
//    01/01/0550 is earlier than 07/18/0622 or later than 12/31/9999

open System
open System.Globalization
open System.Threading

let date1 = DateTimeOffset(DateTime(550, 1, 1), TimeSpan.Zero)

let arSY = CultureInfo "ar-SY"
arSY.DateTimeFormat.Calendar <- HijriCalendar()

// Change current culture to ar-SY.
let dft = Thread.CurrentThread.CurrentCulture
Thread.CurrentThread.CurrentCulture <- arSY

// Display the date using the current culture's calendar.
try
    printfn $"{date1}"
with :? ArgumentOutOfRangeException ->
    printfn $"""{date1.ToString("d", CultureInfo.InvariantCulture)} is earlier than {arSY.DateTimeFormat.Calendar.MinSupportedDateTime.ToString("d", CultureInfo.InvariantCulture)} or later than {arSY.DateTimeFormat.Calendar.MaxSupportedDateTime.ToString("d", CultureInfo.InvariantCulture)}"""

// Restore the default culture.
Thread.CurrentThread.CurrentCulture <- dft

// The example displays the following output:
//    01/01/0550 is earlier than 07/18/0622 or later than 12/31/9999

Imports System.Globalization
Imports System.Threading

Module Example
   Public Sub Main()
      Dim date1 As New DateTimeOffset(#1/1/550#, TimeSpan.Zero)
      Dim dft As CultureInfo
      Dim arSY As New CultureInfo("ar-SY")
      arSY.DateTimeFormat.Calendar = New HijriCalendar()
      
      ' Change current culture to ar-SY.
      dft = Thread.CurrentThread.CurrentCulture
      Thread.CurrentThread.CurrentCulture = arSY
      
      ' Display the date using the current culture's calendar.            
      Try
         Console.WriteLine(date1.ToString())
      Catch e As ArgumentOutOfRangeException
         Console.WriteLine("{0} is earlier than {1:d} or later than {2:d}", _
                           date1.ToString("d", CultureInfo.InvariantCulture), _
                           arSY.DateTimeFormat.Calendar.MinSupportedDateTime.ToString("d", CultureInfo.InvariantCulture), _ 
                           arSY.DateTimeFormat.Calendar.MaxSupportedDateTime.ToString("d", CultureInfo.InvariantCulture)) 
      End Try
      
      ' Restore the default culture.
      Thread.CurrentThread.CurrentCulture = dft
   End Sub
End Module
' The example displays the following output:
'    01/01/0550 is earlier than 07/18/0622 or later than 12/31/9999

適用対象

ToString(IFormatProvider)

ソース:: DateTimeOffset.cs

ソース:: DateTimeOffset.cs

ソース:: DateTimeOffset.cs

指定したカルチャ固有の書式設定情報を使用して、現在の DateTimeOffset オブジェクトの値を等価の文字列形式に変換します。

public:
 System::String ^ ToString(IFormatProvider ^ formatProvider);

public string ToString (IFormatProvider formatProvider);

public string ToString (IFormatProvider? formatProvider);

override this.ToString : IFormatProvider -> string

Public Function ToString (formatProvider As IFormatProvider) As String

パラメーター

formatProvider: IFormatProvider

カルチャ固有の書式設定情報を提供するオブジェクト。

戻り値

String

現在の DateTimeOffset オブジェクトの値の文字列形式 (formatProviderで指定)。

例外

ArgumentOutOfRangeException

日付と時刻が、formatProviderで使用されるカレンダーでサポートされている日付の範囲外です。

例

次の例では、インバリアントカルチャを表す CultureInfo オブジェクトと、その他の 4 つのカルチャを使用して、DateTimeOffset オブジェクトを表示します。

CultureInfo[] cultures = new CultureInfo[] {CultureInfo.InvariantCulture,
                                           new CultureInfo("en-us"),
                                           new CultureInfo("fr-fr"),
                                           new CultureInfo("de-DE"),
                                           new CultureInfo("es-ES")};

DateTimeOffset thisDate = new DateTimeOffset(2007, 5, 1, 9, 0, 0,
                                             TimeSpan.Zero);

foreach (CultureInfo culture in cultures)
{
   string cultureName;
   if (string.IsNullOrEmpty(culture.Name))
      cultureName = culture.NativeName;
   else
      cultureName = culture.Name;

   Console.WriteLine("In {0}, {1}",
                     cultureName, thisDate.ToString(culture));
}
// The example produces the following output:
//    In Invariant Language (Invariant Country), 05/01/2007 09:00:00 +00:00
//    In en-US, 5/1/2007 9:00:00 AM +00:00
//    In fr-FR, 01/05/2007 09:00:00 +00:00
//    In de-DE, 01.05.2007 09:00:00 +00:00
//    In es-ES, 01/05/2007 9:00:00 +00:00

let cultures = 
    [| CultureInfo.InvariantCulture
       CultureInfo "en-us"
       CultureInfo "fr-fr"
       CultureInfo "de-DE"
       CultureInfo "es-ES" |]

let thisDate = DateTimeOffset(2007, 5, 1, 9, 0, 0, TimeSpan.Zero)

for culture in cultures do
    let cultureName = 
        if String.IsNullOrEmpty culture.Name then
            culture.NativeName
        else
            culture.Name
    printfn $"In {cultureName}, {thisDate.ToString culture}"

// The example produces the following output:
//    In Invariant Language (Invariant Country), 05/01/2007 09:00:00 +00:00
//    In en-US, 5/1/2007 9:00:00 AM +00:00
//    In fr-FR, 01/05/2007 09:00:00 +00:00
//    In de-DE, 01.05.2007 09:00:00 +00:00
//    In es-ES, 01/05/2007 9:00:00 +00:00

     Dim cultures() As CultureInfo = {CultureInfo.InvariantCulture, _
                                      New CultureInfo("en-us"), _
                                      New CultureInfo("fr-fr"), _
                                      New CultureInfo("de-DE"), _
                                      New CultureInfo("es-ES")}

     Dim thisDate As New DateTimeOffset(#5/1/2007 9:00AM#, TimeSpan.Zero)                                            

     For Each culture As CultureInfo In cultures
        Dim cultureName As String 
        If String.IsNullOrEmpty(culture.Name) Then
           cultureName = culture.NativeName
        Else
           cultureName = culture.Name
        End If
        Console.WriteLine("In {0}, {1}", _
                          cultureName, thisDate.ToString(culture))
     Next                                            
     ' The example produces the following output:
     '    In Invariant Language (Invariant Country), 05/01/2007 09:00:00 +00:00
     '    In en-US, 5/1/2007 9:00:00 AM +00:00
     '    In fr-FR, 01/05/2007 09:00:00 +00:00
     '    In de-DE, 01.05.2007 09:00:00 +00:00
     '    In es-ES, 01/05/2007 9:00:00 +00:00

注釈

このメソッドの戻り値は、文字列の末尾にスペースとそれに続くオフセットが含まれる点を除き、DateTime.ToString メソッドの同等のオーバーロードの戻り値と同じです。つまり、短い日付パターン、長い時間パターン、およびカスタム書式指定文字列 zzz を使用して出力を書式設定し、各要素をスペースで区切ります。

これら 3 つの要素の形式は、formatProvider パラメーターによって定義されます。 formatProvider パラメーターには、次のいずれかを指定できます。

返された文字列に書式設定規則が適用されるカルチャを表す CultureInfo オブジェクト。 CultureInfo.DateTimeFormat プロパティによって返される DateTimeFormatInfo オブジェクトは、返される文字列の書式設定を定義します。
日付と時刻のデータの形式を定義する DateTimeFormatInfo オブジェクト。

formatProvider が nullされている場合は、現在のカルチャに関連付けられている DateTimeFormatInfo オブジェクトが使用されます (CurrentCultureを参照)。

注意 (呼び出し元)

ToString(IFormatProvider) メソッドは、formatProvider パラメーターで表されるカルチャによって使用されるカレンダーの日付と時刻の文字列形式を返します。カレンダーは、Calendar プロパティによって定義されます。現在の DateTimeOffset インスタンスの値が MinSupportedDateTime より前または MaxSupportedDateTimeより後の場合、メソッドは ArgumentOutOfRangeExceptionをスローします。次の例では、図を示します。 JapaneseCalendar クラスの範囲外の日付の書式設定を試みます。

using System;
using System.Globalization;

public class Example
{
   public static void Main()
   {
      CultureInfo jaJP = new CultureInfo("ja-JP");
      jaJP.DateTimeFormat.Calendar = new JapaneseCalendar();
      DateTimeOffset date1 = new DateTimeOffset(new DateTime(1867, 1, 1),
                                                TimeSpan.Zero);

      try {
         Console.WriteLine(date1.ToString(jaJP));
      }
      catch (ArgumentOutOfRangeException) {
         Console.WriteLine("{0:d} is earlier than {1:d} or later than {2:d}",
                           date1,
                           jaJP.DateTimeFormat.Calendar.MinSupportedDateTime,
                           jaJP.DateTimeFormat.Calendar.MaxSupportedDateTime);
      }
   }
}
// The example displays the following output:
//    1/1/1867 is earlier than 9/8/1868 or later than 12/31/9999

open System
open System.Globalization

let jaJP = CultureInfo "ja-JP"
jaJP.DateTimeFormat.Calendar <- JapaneseCalendar()
let date1 = DateTimeOffset(DateTime(1867, 1, 1), TimeSpan.Zero)

try
    printfn $"{date1.ToString jaJP}"
with :? ArgumentOutOfRangeException ->
    printfn $"{date1:d} is earlier than {jaJP.DateTimeFormat.Calendar.MinSupportedDateTime:d} or later than {jaJP.DateTimeFormat.Calendar.MaxSupportedDateTime:d}"

// The example displays the following output:
//    1/1/1867 is earlier than 9/8/1868 or later than 12/31/9999

Imports System.Globalization

Module Example
   Public Sub Main()
      Dim jaJP As New CultureInfo("ja-JP")
      jaJP.DateTimeFormat.Calendar = New JapaneseCalendar() 
      Dim date1 As New DateTimeOffset(#01/01/1867#, TimeSpan.Zero)

      Try
         Console.WriteLine(date1.ToString(jaJP))
      Catch e As ArgumentOutOfRangeException
         Console.WriteLine("{0:d} is earlier than {1:d} or later than {2:d}", _
                           date1, _
                           jaJP.DateTimeFormat.Calendar.MinSupportedDateTime, _ 
                           jaJP.DateTimeFormat.Calendar.MaxSupportedDateTime) 
      End Try
   End Sub
End Module
' The example displays the following output:
'    1/1/1867 is earlier than 9/8/1868 or later than 12/31/9999

適用対象

ToString(String)

ソース:: DateTimeOffset.cs

ソース:: DateTimeOffset.cs

ソース:: DateTimeOffset.cs

指定した形式を使用して、現在の DateTimeOffset オブジェクトの値を等価の文字列形式に変換します。

public:
 System::String ^ ToString(System::String ^ format);

public string ToString (string format);

public string ToString (string? format);

override this.ToString : string -> string

Public Function ToString (format As String) As String

パラメーター

format: String

書式指定文字列。

戻り値

String

現在の DateTimeOffset オブジェクトの値の文字列形式 (formatで指定)。

例外

FormatException

format の長さは 1 で、DateTimeFormatInfoに定義されている標準書式指定子文字の 1 つではありません。

-又は-

format には、有効なカスタム書式パターンが含まれていません。

ArgumentOutOfRangeException

日付と時刻が、現在のカルチャで使用されているカレンダーでサポートされている日付の範囲外です。

例

次の例では、標準の日時書式指定子を使用して、コンソールに DateTimeOffset オブジェクトを表示します。出力は、en-us カルチャを使用して書式設定されます。

DateTimeOffset outputDate = new DateTimeOffset(2007, 10, 31, 21, 0, 0,
                                     new TimeSpan(-8, 0, 0));
string specifier;

// Output date using each standard date/time format specifier
specifier = "d";
// Displays   d: 10/31/2007
Console.WriteLine("{0}: {1}", specifier, outputDate.ToString(specifier));

specifier = "D";
// Displays   D: Wednesday, October 31, 2007
Console.WriteLine("{0}: {1}", specifier, outputDate.ToString(specifier));

specifier = "t";
// Displays   t: 9:00 PM
Console.WriteLine("{0}: {1}", specifier, outputDate.ToString(specifier));

specifier = "T";
// Displays   T: 9:00:00 PM
Console.WriteLine("{0}: {1}", specifier, outputDate.ToString(specifier));

specifier = "f";
// Displays   f: Wednesday, October 31, 2007 9:00 PM
Console.WriteLine("{0}: {1}", specifier, outputDate.ToString(specifier));

specifier = "F";
// Displays   F: Wednesday, October 31, 2007 9:00:00 PM
Console.WriteLine("{0}: {1}", specifier, outputDate.ToString(specifier));

specifier = "g";
// Displays   g: 10/31/2007 9:00 PM
Console.WriteLine("{0}: {1}", specifier, outputDate.ToString(specifier));

specifier = "G";
// Displays   G: 10/31/2007 9:00:00 PM
Console.WriteLine("{0}: {1}", specifier, outputDate.ToString(specifier));

specifier = "M";           // 'm' is identical
// Displays   M: October 31
Console.WriteLine("{0}: {1}", specifier, outputDate.ToString(specifier));

specifier = "R";           // 'r' is identical
// Displays   R: Thu, 01 Nov 2007 05:00:00 GMT
Console.WriteLine("{0}: {1}", specifier, outputDate.ToString(specifier));

specifier = "s";
// Displays   s: 2007-10-31T21:00:00
Console.WriteLine("{0}: {1}", specifier, outputDate.ToString(specifier));

specifier = "u";
// Displays   u: 2007-11-01 05:00:00Z
Console.WriteLine("{0}: {1}", specifier, outputDate.ToString(specifier));

// Specifier is not supported
specifier = "U";
try
{
   Console.WriteLine("{0}: {1}", specifier, outputDate.ToString(specifier));
}
catch (FormatException)
{
   Console.WriteLine("{0}: Not supported.", specifier);
}

specifier = "Y";         // 'y' is identical
// Displays   Y: October, 2007
Console.WriteLine("{0}: {1}", specifier, outputDate.ToString(specifier));

let outputDate = DateTimeOffset(2007, 10, 31, 21, 0, 0, TimeSpan(-8, 0, 0))

// Output date using each standard date/time format specifier
let specifier = "d"
// Displays   d: 10/31/2007
printfn $"{specifier}: {outputDate.ToString specifier}"

let specifier = "D"
// Displays   D: Wednesday, October 31, 2007
printfn $"{specifier}: {outputDate.ToString specifier}"

let specifier = "t"
// Displays   t: 9:00 PM
printfn $"{specifier}: {outputDate.ToString specifier}"

let specifier = "T"
// Displays   T: 9:00:00 PM
printfn $"{specifier}: {outputDate.ToString specifier}"

let specifier = "f"
// Displays   f: Wednesday, October 31, 2007 9:00 PM
printfn $"{specifier}: {outputDate.ToString specifier}"

let specifier = "F"
// Displays   F: Wednesday, October 31, 2007 9:00:00 PM
printfn $"{specifier}: {outputDate.ToString specifier}"

let specifier = "g"
// Displays   g: 10/31/2007 9:00 PM
printfn $"{specifier}: {outputDate.ToString specifier}"

let specifier = "G"
// Displays   G: 10/31/2007 9:00:00 PM
printfn $"{specifier}: {outputDate.ToString specifier}"

let specifier = "M"           // 'm' is identical
// Displays   M: October 31
printfn $"{specifier}: {outputDate.ToString specifier}"

let specifier = "R"           // 'r' is identical
// Displays   R: Thu, 01 Nov 2007 05:00:00 GMT
printfn $"{specifier}: {outputDate.ToString specifier}"

let specifier = "s"
// Displays   s: 2007-10-31T21:00:00
printfn $"{specifier}: {outputDate.ToString specifier}"

let specifier = "u"
// Displays   u: 2007-11-01 05:00:00Z
printfn $"{specifier}: {outputDate.ToString specifier}"

// Specifier is not supported
let specifier = "U"
try
    printfn $"{specifier}: {outputDate.ToString specifier}"
with :? FormatException ->
    printfn $"{specifier}: Not supported."

let specifier = "Y"         // 'y' is identical
// Displays   Y: October, 2007
printfn $"{specifier}: {outputDate.ToString specifier}"

Dim outputDate As New DateTimeOffset(#10/31/2007 9:00PM#, _
                                     New TimeSpan(-8, 0, 0))
Dim specifier As String 
      
' Output date using each standard date/time format specifier
specifier = "d"
' Displays   d: 10/31/2007
Console.WriteLine("{0}: {1}", specifier, outputDate.ToString(specifier)) 

specifier = "D"
' Displays   D: Wednesday, October 31, 2007
Console.WriteLine("{0}: {1}", specifier, outputDate.ToString(specifier)) 

specifier = "t"
' Displays   t: 9:00 PM
Console.WriteLine("{0}: {1}", specifier, outputDate.ToString(specifier)) 

specifier = "T"
' Displays   T: 9:00:00 PM
Console.WriteLine("{0}: {1}", specifier, outputDate.ToString(specifier)) 

specifier = "f"
' Displays   f: Wednesday, October 31, 2007 9:00 PM
Console.WriteLine("{0}: {1}", specifier, outputDate.ToString(specifier)) 

specifier = "F"
' Displays   F: Wednesday, October 31, 2007 9:00:00 PM
Console.WriteLine("{0}: {1}", specifier, outputDate.ToString(specifier)) 

specifier = "g"
' Displays   g: 10/31/2007 9:00 PM
Console.WriteLine("{0}: {1}", specifier, outputDate.ToString(specifier)) 

specifier = "G"
' Displays   G: 10/31/2007 9:00:00 PM
Console.WriteLine("{0}: {1}", specifier, outputDate.ToString(specifier)) 

specifier = "M"           ' 'm' is identical
' Displays   M: October 31
Console.WriteLine("{0}: {1}", specifier, outputDate.ToString(specifier)) 

specifier = "R"           ' 'r' is identical
' Displays   R: Thu, 01 Nov 2007 05:00:00 GMT
Console.WriteLine("{0}: {1}", specifier, outputDate.ToString(specifier)) 

specifier = "s"
' Displays   s: 2007-10-31T21:00:00
Console.WriteLine("{0}: {1}", specifier, outputDate.ToString(specifier)) 

specifier = "u"
' Displays   u: 2007-11-01 05:00:00Z
Console.WriteLine("{0}: {1}", specifier, outputDate.ToString(specifier)) 

' Specifier is not supported
specifier = "U"
Try
   Console.WriteLine("{0}: {1}", specifier, outputDate.ToString(specifier)) 
Catch e As FormatException
   Console.WriteLine("{0}: Not supported.", specifier)   
End Try

specifier = "Y"         ' 'y' is identical
' Displays   Y: October, 2007
Console.WriteLine("{0}: {1}", specifier, outputDate.ToString(specifier))

注釈

format パラメーターには、単一の書式指定子文字 (標準日時書式指定文字列を参照) または、返される文字列の形式を定義するカスタム書式指定パターン (カスタム日時書式指定文字列を参照) が含まれている必要があります。 format が null または空の文字列 ("") の場合、DateTimeOffset 値は既定の形式を使用して出力されます。

次の表に、DateTimeOffsetで使用する場合の特定の書式指定子の正確な操作を示します。これは、DateTimeで使用した場合の動作とは異なります。

既存の書式指定子	新しい動作
"K"	日付と時刻をラウンドトリップするように設計されています。 DateTimeOffsetでは、"zzz" にマップされます (オフセットは常に時間と分で表示されます)。 "K" はカスタム書式指定子であることに注意してください。`format`では 1 文字として表示できません。
"U"	サポートされていません。
"r"	DateTimeOffset オブジェクトを協定世界時 (UTC) に変換し、カスタム書式指定文字列 `ddd, dd MMM yyyy HH:mm:ss GMT`を使用して出力します。
"u"	DateTimeOffset オブジェクトを UTC に変換し、`yyyy-MM-dd HH:mm:ssZ`形式を使用して出力します。

残りの標準日時書式指定子は、ToString メソッドと同様に、ToString(String) メソッドと同じように動作します。

このメソッドは、現在のカルチャから派生した書式設定情報を使用します。詳細については、CurrentCultureを参照してください。

注意 (呼び出し元)

ToString(String) メソッドは、現在のカルチャで使用されているカレンダーの日付と時刻の文字列形式を返します。現在の DateTimeOffset インスタンスの値が MinSupportedDateTime より前または MaxSupportedDateTimeより後の場合、メソッドは ArgumentOutOfRangeExceptionをスローします。次の例では、図を示します。現在のカルチャがヘブライ語 (イスラエル) の場合、HebrewCalendar クラスの範囲外の日付を書式設定しようとします。

using System;
using System.Globalization;
using System.Threading;

public class Example
{
   public static void Main()
   {
      DateTimeOffset date1 = new DateTimeOffset(new DateTime(1550, 7, 21),
                                                TimeSpan.Zero);
      CultureInfo dft;
      CultureInfo heIL = new CultureInfo("he-IL");
      heIL.DateTimeFormat.Calendar = new HebrewCalendar();

      // Change current culture to he-IL.
      dft = Thread.CurrentThread.CurrentCulture;
      Thread.CurrentThread.CurrentCulture = heIL;

      // Display the date using the current culture's calendar.
      try {
         Console.WriteLine(date1.ToString("G"));
      }
      catch (ArgumentOutOfRangeException) {
         Console.WriteLine("{0} is earlier than {1} or later than {2}",
                           date1.ToString("d", CultureInfo.InvariantCulture),
                           heIL.DateTimeFormat.Calendar.MinSupportedDateTime.ToString("d", CultureInfo.InvariantCulture),
                           heIL.DateTimeFormat.Calendar.MaxSupportedDateTime.ToString("d", CultureInfo.InvariantCulture));
      }

      // Restore the default culture.
      Thread.CurrentThread.CurrentCulture = dft;
   }
}
// The example displays the following output:
//    07/21/1550 is earlier than 01/01/1583 or later than 09/29/2239

open System
open System.Globalization
open System.Threading

let date1 = DateTimeOffset(DateTime(1550, 7, 21), TimeSpan.Zero)

let heIL = CultureInfo "he-IL"
heIL.DateTimeFormat.Calendar <- HebrewCalendar()

// Change current culture to he-IL.
let dft = Thread.CurrentThread.CurrentCulture
Thread.CurrentThread.CurrentCulture <- heIL

// Display the date using the current culture's calendar.
try
    printfn $"{date1:G}"
with :? ArgumentOutOfRangeException ->
    printfn $"""{date1.ToString("d", CultureInfo.InvariantCulture)} is earlier than {heIL.DateTimeFormat.Calendar.MinSupportedDateTime.ToString("d", CultureInfo.InvariantCulture)} or later than {heIL.DateTimeFormat.Calendar.MaxSupportedDateTime.ToString("d", CultureInfo.InvariantCulture)}"""

// Restore the default culture.
Thread.CurrentThread.CurrentCulture <- dft

// The example displays the following output:
//    07/21/1550 is earlier than 01/01/1583 or later than 09/29/2239

Imports System.Globalization
Imports System.Threading

Module Example
   Public Sub Main()
      Dim date1 As New DateTimeOffset(#7/21/1550#, TimeSpan.Zero)
      Dim dft As CultureInfo
      Dim heIL As New CultureInfo("he-IL")
      heIL.DateTimeFormat.Calendar = New HebrewCalendar()
      
      ' Change current culture to he-IL.
      dft = Thread.CurrentThread.CurrentCulture
      Thread.CurrentThread.CurrentCulture = heIL
      
      ' Display the date using the current culture's calendar.            
      Try
         Console.WriteLine(date1.ToString("G"))
      Catch e As ArgumentOutOfRangeException
         Console.WriteLine("{0} is earlier than {1} or later than {2}", _
                           date1.ToString("d", CultureInfo.InvariantCulture), _
                           heIL.DateTimeFormat.Calendar.MinSupportedDateTime.ToString("d", CultureInfo.InvariantCulture), _ 
                           heIL.DateTimeFormat.Calendar.MaxSupportedDateTime.ToString("d", CultureInfo.InvariantCulture)) 
      End Try
      
      ' Restore the default culture.
      Thread.CurrentThread.CurrentCulture = dft
   End Sub
End Module
' The example displays the following output:
'    07/21/1550 is earlier than 01/01/1583 or later than 09/29/2239

こちらもご覧ください

標準の日時書式指定文字列をする
カスタム日時書式指定文字列をする

適用対象

ToString(String, IFormatProvider)

ソース:: DateTimeOffset.cs

ソース:: DateTimeOffset.cs

ソース:: DateTimeOffset.cs

現在の DateTimeOffset オブジェクトの値を、指定した書式およびカルチャ固有の書式情報を使用して、等価の文字列形式に変換します。

public:
 virtual System::String ^ ToString(System::String ^ format, IFormatProvider ^ formatProvider);

public string ToString (string format, IFormatProvider formatProvider);

public string ToString (string? format, IFormatProvider? formatProvider);

override this.ToString : string * IFormatProvider -> string

Public Function ToString (format As String, formatProvider As IFormatProvider) As String

パラメーター

format: String

書式指定文字列。

formatProvider: IFormatProvider

カルチャ固有の書式設定情報を提供するオブジェクト。

戻り値

String

format および formatProviderで指定された、現在の DateTimeOffset オブジェクトの値の文字列形式。

実装

ToString(String, IFormatProvider)

例外

FormatException

format の長さは 1 で、DateTimeFormatInfoに定義されている標準書式指定子文字の 1 つではありません。

-又は-

format には、有効なカスタム書式パターンが含まれていません。

ArgumentOutOfRangeException

日付と時刻が、formatProviderで使用されるカレンダーでサポートされている日付の範囲外です。

例

次の例では、ToString(String, IFormatProvider) メソッドを使用して、複数の異なるカルチャのカスタム書式指定文字列を使用して DateTimeOffset オブジェクトを表示します。

DateTimeOffset outputDate = new DateTimeOffset(2007, 11, 1, 9, 0, 0,
                                     new TimeSpan(-7, 0, 0));
string format = "dddd, MMM dd yyyy HH:mm:ss zzz";

// Output date and time using custom format specification
Console.WriteLine(outputDate.ToString(format, null as DateTimeFormatInfo));
Console.WriteLine(outputDate.ToString(format, CultureInfo.InvariantCulture));
Console.WriteLine(outputDate.ToString(format,
                                      new CultureInfo("fr-FR")));
Console.WriteLine(outputDate.ToString(format,
                                      new CultureInfo("es-ES")));
// The example displays the following output to the console:
//    Thursday, Nov 01 2007 09:00:00 -07:00
//    Thursday, Nov 01 2007 09:00:00 -07:00
//    jeudi, nov. 01 2007 09:00:00 -07:00
//    jueves, nov 01 2007 09:00:00 -07:00

let outputDate = DateTimeOffset(2007, 11, 1, 9, 0, 0, TimeSpan(-7, 0, 0))
let format = "dddd, MMM dd yyyy HH:mm:ss zzz"

// Output date and time using custom format specification
printfn $"{outputDate.ToString(format, null)}"
printfn $"{outputDate.ToString(format, CultureInfo.InvariantCulture)}"
printfn $"""{outputDate.ToString(format, CultureInfo "fr-FR")}"""
printfn $"""{outputDate.ToString(format, CultureInfo "es-ES")}"""

// The example displays the following output to the console:
//    Thursday, Nov 01 2007 09:00:00 -07:00
//    Thursday, Nov 01 2007 09:00:00 -07:00
//    jeudi, nov. 01 2007 09:00:00 -07:00
//    jueves, nov 01 2007 09:00:00 -07:00

Dim outputDate As New DateTimeOffset(#11/1/2007 9:00AM#, _
                                     New TimeSpan(-7, 0, 0)) 
Dim format As String = "dddd, MMM dd yyyy HH:mm:ss zzz"

' Output date and time using custom format specification
Console.WriteLine(outputDate.ToString(format, Nothing))
Console.WriteLine(outputDate.ToString(format, CultureInfo.InvariantCulture))
Console.WriteLine(outputDate.ToString(format, _
                                      New CultureInfo("fr-FR")))
Console.WriteLine(outputDate.ToString(format, _
                                      New CultureInfo("es-ES")))
' The example displays the following output to the console:
'    Thursday, Nov 01 2007 09:00:00 -07:00
'    Thursday, Nov 01 2007 09:00:00 -07:00
'    jeudi, nov. 01 2007 09:00:00 -07:00
'    jueves, nov 01 2007 09:00:00 -07:00

注釈

format パラメーターには、単一の書式指定子文字 (標準の日付と時刻書式指定文字列のを参照) またはカスタム書式指定パターン (カスタム日時書式指定文字列を参照) を含める必要があります。 format が null または空の文字列 ("") の場合、DateTimeOffset オブジェクトは既定の形式を使用して出力されます。

次の表に、DateTimeOffsetで使用する場合の特定の書式指定子の正確な操作を示します。これは、DateTimeで使用した場合の動作とは異なります。

既存の書式指定子	新しい動作
"K"	日付と時刻をラウンドトリップするように設計されています。 DateTimeOffsetでは、"zzz" にマップされます (オフセットは常に時間と分で表示されます)。 "K" はカスタム書式指定子であることに注意してください。`format`では 1 文字として表示できません。
"U"	サポートされていません。
"r"	DateTimeOffset オブジェクトを協定世界時 (UTC) に変換し、カスタム書式指定文字列 `ddd, dd MMM yyyy HH:mm:ss GMT`を使用して出力します。
"u"	DateTimeOffset 値を UTC に変換し、`yyyy-MM-dd HH:mm:ssZ`形式を使用して出力します。

残りの標準日時書式指定子は、ToString メソッドと同様に、ToString(String) メソッドと同じように動作します。

標準書式指定子に対応するパターン、および日付と時刻コンポーネントのシンボルと名前は、formatProvider パラメーターによって定義されます。 formatProvider パラメーターには、次のいずれかを指定できます。

inputで書式設定が使用されるカルチャを表す CultureInfo オブジェクト。 CultureInfo.DateTimeFormat プロパティによって返される DateTimeFormatInfo オブジェクトは、inputで使用される書式を定義します。
日付と時刻のデータの形式を定義する DateTimeFormatInfo オブジェクト。

formatProvider が nullされている場合は、現在のカルチャに関連付けられている DateTimeFormatInfo オブジェクトが使用されます (CurrentCultureを参照)。

注意 (呼び出し元)

ToString(String, IFormatProvider) メソッドは、formatProvider パラメーターで使用されるカレンダーの日付と時刻の文字列形式を返します。カレンダーは、Calendar プロパティによって定義されます。現在の DateTimeOffset インスタンスの値が MinSupportedDateTime より前または MaxSupportedDateTimeより後の場合、メソッドは ArgumentOutOfRangeExceptionをスローします。次の例では、図を示します。 UmAlQuraCalendar クラスの範囲外の日付の書式設定を試みます。

using System;
using System.Globalization;

public class Example
{
   public static void Main()
   {
      CultureInfo arSA = new CultureInfo("ar-SA");
      arSA.DateTimeFormat.Calendar = new UmAlQuraCalendar();
      DateTimeOffset date1 = new DateTimeOffset(new DateTime(1890, 9, 10),
                                                TimeSpan.Zero);

      try {
         Console.WriteLine(date1.ToString("d", arSA));
      }
      catch (ArgumentOutOfRangeException) {
         Console.WriteLine("{0:d} is earlier than {1:d} or later than {2:d}",
                           date1,
                           arSA.DateTimeFormat.Calendar.MinSupportedDateTime,
                           arSA.DateTimeFormat.Calendar.MaxSupportedDateTime);
      }
   }
}
// The example displays the following output:
//    9/10/1890 is earlier than 4/30/1900 or later than 5/13/2029

open System
open System.Globalization

let arSA = CultureInfo "ar-SA"
arSA.DateTimeFormat.Calendar <- UmAlQuraCalendar()
let date1 = DateTimeOffset(DateTime(1890, 9, 10), TimeSpan.Zero)

try
    printfn $"""{date1.ToString("d", arSA)}"""
with :? ArgumentOutOfRangeException ->
    printfn $"{date1:d} is earlier than {arSA.DateTimeFormat.Calendar.MinSupportedDateTime:d} or later than {arSA.DateTimeFormat.Calendar.MaxSupportedDateTime:d}"

// The example displays the following output:
//    9/10/1890 is earlier than 4/30/1900 or later than 11/16/2077

Imports System.Globalization

Module Example
   Public Sub Main()
      Dim arSA As New CultureInfo("ar-SA")
      arSA.DateTimeFormat.Calendar = New UmAlQuraCalendar() 
      Dim date1 As New DateTimeOffset(#09/10/1890#, TimeSpan.Zero)

      Try
         Console.WriteLine(date1.ToString("d", arSA))
      Catch e As ArgumentOutOfRangeException
         Console.WriteLine("{0:d} is earlier than {1:d} or later than {2:d}", _
                           date1, _
                           arSA.DateTimeFormat.Calendar.MinSupportedDateTime, _ 
                           arSA.DateTimeFormat.Calendar.MaxSupportedDateTime) 
      End Try
   End Sub
End Module
' The example displays the following output:
'    9/10/1890 is earlier than 4/30/1900 or later than 5/13/2029

こちらもご覧ください

標準の日時書式指定文字列をする
カスタム日時書式指定文字列をする
サンプル: .NET Core WinForms Formatting Utility (C#)
サンプル: .NET Core WinForms Formatting Utility (Visual Basic)

適用対象

次の方法で共有

DateTimeOffset.ToString メソッド

定義

オーバーロード

ToString()

戻り値

例外

例

注釈

注意 (呼び出し元)

適用対象

ToString(IFormatProvider)

パラメーター

戻り値

例外

例

注釈

注意 (呼び出し元)

適用対象

ToString(String)

パラメーター

戻り値

例外

例

注釈

注意 (呼び出し元)

こちらもご覧ください

適用対象

ToString(String, IFormatProvider)

パラメーター

戻り値

実装

例外

例

注釈

注意 (呼び出し元)

こちらもご覧ください

適用対象

その他のリソース