DateTimeOffset.ToString Méthode

Définition

Convertit la valeur de l'objet DateTimeOffset actif en sa représentation équivalente sous forme de chaîne.Converts the value of the current DateTimeOffset object to its equivalent string representation.

Surcharges

ToString()

Convertit la valeur de l'objet DateTimeOffset actif en sa représentation équivalente sous forme de chaîne.Converts the value of the current DateTimeOffset object to its equivalent string representation.

ToString(IFormatProvider)

Convertit la valeur de l'objet DateTimeOffset en cours en représentation sous forme de chaîne équivalente à l'aide des informations de format propres à la culture spécifiées.Converts the value of the current DateTimeOffset object to its equivalent string representation using the specified culture-specific formatting information.

ToString(String)

Convertit la valeur de l'objet DateTimeOffset actuel en sa représentation sous forme de chaîne équivalente en utilisant le format spécifié.Converts the value of the current DateTimeOffset object to its equivalent string representation using the specified format.

ToString(String, IFormatProvider)

Convertit la valeur de l'objet DateTimeOffset actuel en sa représentation sous forme de chaîne équivalente à l'aide du format et des informations de format spécifiques à la culture spécifiés.Converts the value of the current DateTimeOffset object to its equivalent string representation using the specified format and culture-specific format information.

ToString()

Convertit la valeur de l'objet DateTimeOffset actif en sa représentation équivalente sous forme de chaîne.Converts the value of the current DateTimeOffset object to its equivalent string representation.

public:
 override System::String ^ ToString();
public override string ToString ();
override this.ToString : unit -> string
Public Overrides Function ToString () As String

Retours

String

Représentation sous forme de chaîne d'un objet DateTimeOffsetqui inclut l'offset ajouté à la fin de la chaîne.A string representation of a DateTimeOffset object that includes the offset appended at the end of the string.

Exceptions

La date et l’heure sont en dehors de la plage de dates prise en charge par le calendrier utilisé par la culture actuelle.The date and time is outside the range of dates supported by the calendar used by the current culture.

Exemples

L’exemple suivant illustre les appels à la ToString() méthode et affiche sa sortie sur un système dont la culture actuelle est en-US.The following example illustrates calls to the ToString() method and displays its output on a system whose current culture is 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
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

Remarques

La valeur de retour de cette méthode est identique à celle de la DateTime.ToString() méthode, à ceci près qu’elle comprend un espace suivi de l’offset ajouté à la fin de la chaîne.The return value of this method is identical to that of the DateTime.ToString() method, except that it includes a space followed by the offset appended at the end of the string. En d’autres termes, il met en forme la sortie à l’aide du modèle de date abrégée, du modèle d’heure longue et de la zzz chaîne de format personnalisée, chaque élément étant séparé de l’élément précédent par un espace.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. Par exemple, si DateTime.ToString() retourne une valeur de 1/12/2008 6:15:50 PM, ToString() retourne une valeur de 1/12/2008 6:15:50 pm-08:00 pour une heure qui est de huit heures après le temps universel coordonné (UTC).For example, if DateTime.ToString() returns a value of 1/12/2008 6:15:50 PM, ToString() returns a value of 1/12/2008 6:15:50 PM -08:00 for a time that is eight hours behind Coordinated Universal Time (UTC).

Cette méthode utilise les informations de mise en forme dérivées de la culture actuelle.This method uses formatting information derived from the current culture. Pour plus d'informations, consultez CurrentCulture.For more information, see CurrentCulture. D’autres surcharges de la ToString méthode vous permettent de spécifier la culture dont la mise en forme doit être utilisée, et de définir le modèle de sortie de la DateTimeOffset valeur.Other overloads of the ToString method enable you to specify the culture whose formatting to use, and to define the output pattern of the DateTimeOffset value.

Notes pour les appelants

La ToString() méthode retourne la représentation sous forme de chaîne de la date et de l’heure dans le calendrier utilisé par la culture actuelle.The ToString() method returns the string representation of the date and time in the calendar used by the current culture. Si la valeur de l' DateTimeOffset instance actuelle est antérieure MinSupportedDateTime ou ultérieure à MaxSupportedDateTime , la méthode lève une ArgumentOutOfRangeException .If the value of the current DateTimeOffset instance is earlier than MinSupportedDateTime or later than MaxSupportedDateTime, the method throws an ArgumentOutOfRangeException. L'exemple suivant illustre cette situation.The following example provides an illustration. Il tente de mettre en forme une date en dehors de la plage de la HijriCalendar classe lorsque la culture actuelle est en arabe (Syrie).It attempts to format a date that is outside the range of the HijriCalendar class when the current culture is Arabic (Syria).

[ ! code-CSharpSystem. DateTimeOffset. ToString. ArgumentOutOfRangeException # 2] [ ! code-VBSystem. DateTimeOffset. ToString. ArgumentOutOfRangeException # 2][!code-csharpSystem.DateTimeOffset.ToString.ArgumentOutOfRangeException#2] [!code-vbSystem.DateTimeOffset.ToString.ArgumentOutOfRangeException#2]

S’applique à

ToString(IFormatProvider)

Convertit la valeur de l'objet DateTimeOffset en cours en représentation sous forme de chaîne équivalente à l'aide des informations de format propres à la culture spécifiées.Converts the value of the current DateTimeOffset object to its equivalent string representation using the specified culture-specific formatting information.

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

Paramètres

formatProvider
IFormatProvider

Objet qui fournit des informations de mise en forme propres à la culture.An object that supplies culture-specific formatting information.

Retours

String

Représentation sous forme de chaîne de la valeur de l’objet DateTimeOffset actuel, telle que spécifiée par formatProvider.A string representation of the value of the current DateTimeOffset object, as specified by formatProvider.

Exceptions

La date et l’heure sont en dehors de la plage de dates prise en charge par le calendrier utilisé par formatProvider.The date and time is outside the range of dates supported by the calendar used by formatProvider.

Exemples

L’exemple suivant affiche un DateTimeOffset objet à l’aide d' CultureInfo objets qui représentent la culture dite indifférente, ainsi que quatre autres cultures.The following example displays a DateTimeOffset object using CultureInfo objects that represent the invariant culture, as well as four other cultures.

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
     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

Remarques

La valeur de retour de cette méthode est identique à celle de sa surcharge équivalente de la DateTime.ToString méthode, à ceci près qu’elle comprend un espace suivi de l’offset ajouté à la fin de la chaîne.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. En d’autres termes, il met en forme la sortie à l’aide du modèle de date abrégée, du modèle d’heure longue et de la zzz chaîne de format personnalisée, chaque élément étant séparé de l’élément précédent par un espace.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.

Le format de ces trois éléments est défini par le formatProvider paramètre.The format of these three elements is defined by the formatProvider parameter. Le formatProvider paramètre peut être l’un des suivants :The formatProvider parameter can be either of the following:

Si formatProvider est null , l' DateTimeFormatInfo objet associé à la culture actuelle est utilisé (consultez CurrentCulture ).If formatProvider is null, the DateTimeFormatInfo object associated with the current culture is used (see CurrentCulture).

Notes pour les appelants

La ToString(IFormatProvider) méthode retourne la représentation sous forme de chaîne de la date et de l’heure dans le calendrier utilisé par la culture représentée par le formatProvider paramètre.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. Son calendrier est défini par la Calendar propriété.Its calendar is defined by the Calendar property. Si la valeur de l' DateTimeOffset instance actuelle est antérieure MinSupportedDateTime ou ultérieure à MaxSupportedDateTime , la méthode lève une ArgumentOutOfRangeException .If the value of the current DateTimeOffset instance is earlier than MinSupportedDateTime or later than MaxSupportedDateTime, the method throws an ArgumentOutOfRangeException. L'exemple suivant illustre cette situation.The following example provides an illustration. Il tente de mettre en forme une date en dehors de la plage de la JapaneseCalendar classe.It attempts to format a date that is outside the range of the JapaneseCalendar class.

::: code Language = "CSharp" source = "~/Samples/snippets/CSharp/VS_Snippets_CLR_System/System.DateTimeOffset.ToString.ArgumentOutOfRangeException/CS/DateTimeOffset.ToString.argumentoutofrangeexception1.cs" interactive = "Try-dotnet" ID = "Snippet1" :::::: code Language = "VB" source = "~/Samples/snippets/VisualBasic/VS_Snippets_CLR_System/System.DateTimeOffset.ToString.ArgumentOutOfRangeException/VB/DateTimeOffset.ToString.argumentoutofrangeexception1.vb" ID = "Snippet1" ::::::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_CLR_System/system.datetimeoffset.tostring.argumentoutofrangeexception/cs/datetimeoffset.tostring.argumentoutofrangeexception1.cs" interactive="try-dotnet" id="Snippet1"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_CLR_System/system.datetimeoffset.tostring.argumentoutofrangeexception/vb/datetimeoffset.tostring.argumentoutofrangeexception1.vb" id="Snippet1":::

S’applique à

ToString(String)

Convertit la valeur de l'objet DateTimeOffset actuel en sa représentation sous forme de chaîne équivalente en utilisant le format spécifié.Converts the value of the current DateTimeOffset object to its equivalent string representation using the specified format.

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

Paramètres

format
String

Chaîne de format.A format string.

Retours

String

Représentation sous forme de chaîne de la valeur de l’objet DateTimeOffset actuel, telle que spécifiée par format.A string representation of the value of the current DateTimeOffset object, as specified by format.

Exceptions

La longueur de format est égale à un, et ce n’est pas l’un des caractères spécificateurs de format standard définis pour DateTimeFormatInfo.The length of format is one, and it is not one of the standard format specifier characters defined for DateTimeFormatInfo.

- ou --or- format ne contient pas un modèle de format personnalisé valide.format does not contain a valid custom format pattern.

La date et l’heure sont en dehors de la plage de dates prise en charge par le calendrier utilisé par la culture actuelle.The date and time is outside the range of dates supported by the calendar used by the current culture.

Exemples

L’exemple suivant affiche un DateTimeOffset objet dans la console à l’aide de chacun des spécificateurs de format de date et d’heure standard.The following example displays a DateTimeOffset object to the console using each of the standard date and time format specifiers. La sortie est mise en forme à l’aide de la culture en-US.The output is formatted by using the en-us culture.

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));
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)) 

Remarques

Le format paramètre doit contenir un caractère spécificateur de format unique (consultez chaînes de format de date et d’heure standard) ou un modèle de format personnalisé (consultez chaînes de format de date et d’heure personnalisées) qui définit le format de la chaîne retournée.The format parameter should contain either a single format specifier character (see Standard Date and Time Format Strings) or a custom format pattern (see Custom Date and Time Format Strings) that defines the format of the returned string. Si format est une chaîne null ou vide (""), la DateTimeOffset valeur est sortie à l’aide du format par défaut.If format is a null or empty string (""), the DateTimeOffset value is output using the default format.

Le tableau suivant montre l’opération exacte de certains spécificateurs de format lorsqu’il DateTimeOffset est utilisé avec, qui diffère de leur comportement lorsqu’il est utilisé avec DateTime .The following table shows the exact operation of certain format specifiers when used with DateTimeOffset, which differs from their behavior when used with DateTime.

Spécificateur de format existantExisting format specifier Nouveau comportementNew behavior
"K""K" Conçu pour effectuer un aller-retour d’une date et d’une heure.Designed to round-trip a date and time. Avec DateTimeOffset , correspond à « zzz » (le décalage est toujours affiché avec les heures et les minutes).With DateTimeOffset, maps to "zzz" (the offset is always displayed with hours and minutes). Notez que « K » est un spécificateur de format personnalisé ; il ne peut pas apparaître comme caractère unique dans format .Note that "K" is a custom format specifier; it cannot appear as the single character in format.
"U""U" Non pris en charge.Not supported.
r"r" Convertit l' DateTimeOffset objet en temps universel coordonné (UTC, Universal Time Coordinated) et le sort à l’aide de la chaîne de format personnalisée ddd, dd MMM yyyy HH:mm:ss GMT .Converts the DateTimeOffset object to Coordinated Universal Time (UTC) and outputs it using the custom format string ddd, dd MMM yyyy HH:mm:ss GMT.
"u""u" Convertit l' DateTimeOffset objet en heure UTC et le retourne en utilisant le format yyyy-MM-dd HH:mm:ssZ .Converts the DateTimeOffset object to UTC and outputs it using the format yyyy-MM-dd HH:mm:ssZ.

Les spécificateurs de format de date et d’heure standard restants se comportent de la même ToString(String) façon que la méthode, comme c’est le cas avec la méthode ToString .The remaining standard date and time format specifiers behave the same with the ToString(String) method as they do with the ToString method.

Cette méthode utilise les informations de mise en forme dérivées de la culture actuelle.This method uses formatting information derived from the current culture. Pour plus d'informations, consultez CurrentCulture.For more information, see CurrentCulture.

Notes pour les appelants

La ToString(String) méthode retourne la représentation sous forme de chaîne de la date et de l’heure dans le calendrier utilisé par la culture actuelle.The ToString(String) method returns the string representation of the date and time in the calendar used by the current culture. Si la valeur de l' DateTimeOffset instance actuelle est antérieure MinSupportedDateTime ou ultérieure à MaxSupportedDateTime , la méthode lève une ArgumentOutOfRangeException .If the value of the current DateTimeOffset instance is earlier than MinSupportedDateTime or later than MaxSupportedDateTime, the method throws an ArgumentOutOfRangeException. L'exemple suivant illustre cette situation.The following example provides an illustration. Il tente de mettre en forme une date en dehors de la plage de la HebrewCalendar classe lorsque la culture actuelle est l’hébreu (Israël).It attempts to format a date that is outside the range of the HebrewCalendar class when the current culture is Hebrew (Israel).

::: code Language = "CSharp" source = "~/Samples/snippets/CSharp/VS_Snippets_CLR_System/System.DateTimeOffset.ToString.ArgumentOutOfRangeException/CS/DateTimeOffset.ToString.argumentoutofrangeexception3.cs" interactive = "Try-dotnet" ID = "Snippet3" :::::: code Language = "VB" source = "~/Samples/snippets/VisualBasic/VS_Snippets_CLR_System/System.DateTimeOffset.ToString.ArgumentOutOfRangeException/VB/DateTimeOffset.ToString.argumentoutofrangeexception3.vb" ID = "Snippet3" ::::::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_CLR_System/system.datetimeoffset.tostring.argumentoutofrangeexception/cs/datetimeoffset.tostring.argumentoutofrangeexception3.cs" interactive="try-dotnet" id="Snippet3"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_CLR_System/system.datetimeoffset.tostring.argumentoutofrangeexception/vb/datetimeoffset.tostring.argumentoutofrangeexception3.vb" id="Snippet3":::

Voir aussi

S’applique à

ToString(String, IFormatProvider)

Convertit la valeur de l'objet DateTimeOffset actuel en sa représentation sous forme de chaîne équivalente à l'aide du format et des informations de format spécifiques à la culture spécifiés.Converts the value of the current DateTimeOffset object to its equivalent string representation using the specified format and culture-specific format information.

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

Paramètres

format
String

Chaîne de format.A format string.

formatProvider
IFormatProvider

Objet qui fournit des informations de mise en forme propres à la culture.An object that supplies culture-specific formatting information.

Retours

String

Représentation sous forme de chaîne de la valeur de l’objet DateTimeOffset actif, tel que spécifié par format et provider.A string representation of the value of the current DateTimeOffset object, as specified by format and provider.

Implémente

Exceptions

La longueur de format est égale à un, et ce n’est pas l’un des caractères spécificateurs de format standard définis pour DateTimeFormatInfo.The length of format is one, and it is not one of the standard format specifier characters defined for DateTimeFormatInfo.

- ou --or- format ne contient pas un modèle de format personnalisé valide.format does not contain a valid custom format pattern.

La date et l’heure sont en dehors de la plage de dates prise en charge par le calendrier utilisé par formatProvider.The date and time is outside the range of dates supported by the calendar used by formatProvider.

Exemples

L’exemple suivant utilise la ToString(String, IFormatProvider) méthode pour afficher un DateTimeOffset objet à l’aide d’une chaîne de format personnalisée pour plusieurs cultures différentes.The following example uses the ToString(String, IFormatProvider) method to display a DateTimeOffset object using a custom format string for several different cultures.

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
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

Remarques

Le format paramètre doit contenir un caractère spécificateur de format unique (consultez chaînes de format de date et d’heure standard) ou un modèle de format personnalisé (consultez chaînes de format de date et d’heure personnalisées).The format parameter should contain either a single format specifier character (see Standard Date and Time Format Strings) or a custom format pattern (see Custom Date and Time Format Strings). Si format est une chaîne null ou vide (""), l' DateTimeOffset objet est généré en utilisant le format par défaut.If format is a null or empty string (""), the DateTimeOffset object is output using the default format.

Le tableau suivant montre l’opération exacte de certains spécificateurs de format lorsqu’il DateTimeOffset est utilisé avec, qui diffère de leur comportement lorsqu’il est utilisé avec DateTime .The following table shows the exact operation of certain format specifiers when used with DateTimeOffset, which differs from their behavior when used with DateTime.

Spécificateur de format existantExisting format specifier Nouveau comportementNew behavior
"K""K" Conçu pour effectuer un aller-retour d’une date et d’une heure.Designed to round-trip a date and time. Avec DateTimeOffset , correspond à « zzz » (le décalage est toujours affiché avec les heures et les minutes).With DateTimeOffset, maps to "zzz" (the offset is always displayed with hours and minutes). Notez que « K » est un spécificateur de format personnalisé ; il ne peut pas apparaître comme caractère unique dans format .Note that "K" is a custom format specifier; it cannot appear as the single character in format.
"U""U" Non pris en charge.Not supported.
r"r" Convertit l' DateTimeOffset objet en temps universel coordonné (UTC, Universal Time Coordinated) et le sort à l’aide de la chaîne de format personnalisée ddd, dd MMM yyyy HH:mm:ss GMT .Converts the DateTimeOffset object to Coordinated Universal Time (UTC) and outputs it using the custom format string ddd, dd MMM yyyy HH:mm:ss GMT.
"u""u" Convertit la DateTimeOffset valeur en heure UTC et la sort en utilisant le format yyyy-MM-dd HH:mm:ssZ .Converts the DateTimeOffset value to UTC and outputs it using the format yyyy-MM-dd HH:mm:ssZ.

Les spécificateurs de format de date et d’heure standard restants se comportent de la même ToString(String) façon que la méthode, comme c’est le cas avec la méthode ToString .The remaining standard date and time format specifiers behave the same with the ToString(String) method as they do with the ToString method.

Le modèle qui correspond aux spécificateurs de format standard, ainsi que les symboles et les noms des composants de date et d’heure, sont définis par le formatProvider paramètre.The pattern that corresponds to standard format specifiers, as well as the symbols and names of date and time components, is defined by the formatProvider parameter. Le formatProvider paramètre peut être l’un des suivants :The formatProvider parameter can be either of the following:

Si formatProvider est null , l' DateTimeFormatInfo objet associé à la culture actuelle est utilisé (consultez CurrentCulture ).If formatProvider is null, the DateTimeFormatInfo object associated with the current culture is used (see CurrentCulture).

Notes pour les appelants

La ToString(String, IFormatProvider) méthode retourne la représentation sous forme de chaîne de la date et de l’heure dans le calendrier utilisé par le formatProvider paramètre.The ToString(String, IFormatProvider) method returns the string representation of the date and time in the calendar used by the formatProvider parameter. Son calendrier est défini par la Calendar propriété.Its calendar is defined by the Calendar property. Si la valeur de l' DateTimeOffset instance actuelle est antérieure MinSupportedDateTime ou ultérieure à MaxSupportedDateTime , la méthode lève une ArgumentOutOfRangeException .If the value of the current DateTimeOffset instance is earlier than MinSupportedDateTime or later than MaxSupportedDateTime, the method throws an ArgumentOutOfRangeException. L'exemple suivant illustre cette situation.The following example provides an illustration. Il tente de mettre en forme une date en dehors de la plage de la UmAlQuraCalendar classe.It attempts to format a date that is outside the range of the UmAlQuraCalendar class.

::: code Language = "CSharp" source = "~/Samples/snippets/CSharp/VS_Snippets_CLR_System/System.DateTimeOffset.ToString.ArgumentOutOfRangeException/CS/DateTimeOffset.ToString.argumentoutofrangeexception4.cs" ID = "Snippet4" :::::: code Language = "VB" source = "~/Samples/snippets/VisualBasic/VS_Snippets_CLR_System/System.DateTimeOffset.ToString.ArgumentOutOfRangeException/VB/DateTimeOffset.ToString.argumentoutofrangeexception4.vb" ID = "Snippet4" ::::::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_CLR_System/system.datetimeoffset.tostring.argumentoutofrangeexception/cs/datetimeoffset.tostring.argumentoutofrangeexception4.cs" id="Snippet4"::: :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_CLR_System/system.datetimeoffset.tostring.argumentoutofrangeexception/vb/datetimeoffset.tostring.argumentoutofrangeexception4.vb" id="Snippet4":::

Voir aussi

S’applique à