IFormattable.ToString(String, IFormatProvider) Method

Definition

Met en forme la valeur de l'instance actuelle au format spécifié.Formats the value of the current instance using the specified format.

public:
 System::String ^ ToString(System::String ^ format, IFormatProvider ^ formatProvider);
public string ToString (string format, IFormatProvider formatProvider);
abstract member ToString : string * IFormatProvider -> string
Public Function ToString (format As String, formatProvider As IFormatProvider) As String

Parameters

format
String

Format à utiliser.The format to use.

-ou--or- Référence null (Nothing en Visual Basic) pour utiliser le format par défaut défini pour le type de l’implémentation IFormattable.A null reference (Nothing in Visual Basic) to use the default format defined for the type of the IFormattable implementation.

formatProvider
IFormatProvider

Fournisseur à utiliser pour mettre en forme la valeur.The provider to use to format the value.

-ou--or- Référence null (Nothing en Visual Basic) pour obtenir les informations de format numérique dans les paramètres régionaux actuels du système d’exploitation.A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.

Returns

String

Valeur de l'instance actuelle au format spécifié.The value of the current instance in the specified format.

Examples

L’exemple suivant illustre une classe Temperature qui implémente la méthode ToString.The following example demonstrates a Temperature class that implements the ToString method. Cet exemple de code fait partie d’un exemple plus complet fourni pour la classe IFormattable.This code example is part of a larger example provided for the IFormattable class.

using System;
using System.Globalization;

public class Temperature : IFormattable
{
   private decimal temp;

   public Temperature(decimal temperature)
   {
      if (temperature < -273.15m)
        throw new ArgumentOutOfRangeException(String.Format("{0} is less than absolute zero.",
                                              temperature));
      this.temp = temperature;
   }

   public decimal Celsius
   {
      get { return temp; }
   }

   public decimal Fahrenheit
   {
      get { return temp * 9 / 5 + 32; }
   }

   public decimal Kelvin
   {
      get { return temp + 273.15m; }
   }

   public override string ToString()
   {
      return this.ToString("G", CultureInfo.CurrentCulture);
   }

   public string ToString(string format)
   {
      return this.ToString(format, CultureInfo.CurrentCulture);
   }

   public string ToString(string format, IFormatProvider provider)
   {
      if (String.IsNullOrEmpty(format)) format = "G";
      if (provider == null) provider = CultureInfo.CurrentCulture;

      switch (format.ToUpperInvariant())
      {
         case "G":
         case "C":
            return temp.ToString("F2", provider) + " °C";
         case "F":
            return Fahrenheit.ToString("F2", provider) + " °F";
         case "K":
            return Kelvin.ToString("F2", provider) + " K";
         default:
            throw new FormatException(String.Format("The {0} format string is not supported.", format));
      }
   }
}
Imports System.Globalization

Public Class Temperature : Implements IFormattable
   Private temp As Decimal
   
   Public Sub New(temperature As Decimal)
      If temperature < -273.15 Then _ 
        Throw New ArgumentOutOfRangeException(String.Format("{0} is less than absolute zero.", _
                                              temperature))
      Me.temp = temperature
   End Sub
   
   Public ReadOnly Property Celsius As Decimal
      Get
         Return temp
      End Get
   End Property
   
   Public ReadOnly Property Fahrenheit As Decimal
      Get
         Return temp * 9 / 5 + 32
      End Get
   End Property
   
   Public ReadOnly Property Kelvin As Decimal
      Get
         Return temp + 273.15d
      End Get
   End Property

   Public Overrides Function ToString() As String
      Return Me.ToString("G", CultureInfo.CurrentCulture)
   End Function
      
   Public Overloads Function ToString(fmt As String) As String
      Return Me.ToString(fmt, CultureInfo.CurrentCulture)
   End Function
   
   Public Overloads Function ToString(fmt As String, provider As IFormatProvider) _
                   As String _
                   Implements IFormattable.ToString
      If String.IsNullOrEmpty(fmt) Then fmt = "G"
      If provider Is Nothing Then provider = CultureInfo.CurrentCulture
      
      Select Case fmt.ToUpperInvariant()
         Case "G", "C"
            Return temp.ToString("F2", provider) + " °C" 
         Case "F"
            Return Fahrenheit.ToString("F2", provider) + " °F"
         Case "K"
            Return Kelvin.ToString("F2", provider) + " K"
         Case Else
            Throw New FormatException(String.Format("The {0} format string is not supported.", fmt))
      End Select
   End Function
End Class

Remarks

La méthode ToString convertit une valeur en une représentation sous forme de chaîne qui peut être exprimée de plusieurs façons.The ToString method converts a value to a string representation that can be expressed in multiple ways. Son format précis dépend de symboles spécifiques ou d’un ordre spécifié défini par des cultures, des professions ou des industries spécifiques.Its precise format depends on specific symbols or a specified order defined by specific cultures, professions, or industries. Vous pouvez appeler directement la méthode.You can call the method directly. Il est également appelé automatiquement par les méthodes Convert.ToString(Object) et Convert.ToString(Object, IFormatProvider), et par les méthodes qui utilisent la fonctionnalité de mise en forme composite dans le .NET Framework, telles que String.Format(String, Object[]), Console.WriteLine(String, Object[])et StringBuilder.AppendFormat(String, Object[]).It is also called automatically by the Convert.ToString(Object) and Convert.ToString(Object, IFormatProvider) methods, and by methods that use the composite formatting feature in the .NET Framework, such as String.Format(String, Object[]), Console.WriteLine(String, Object[]), and StringBuilder.AppendFormat(String, Object[]). (Pour plus d’informations, consultez mise en forme composite.)(For more information, see Composite Formatting.)

Les méthodes de mise en forme composite appellent la méthode ToString une fois pour chaque élément de mise en forme dans une chaîne de format.Composite formatting methods call the ToString method once for each format item in a format string. Les paramètres passés à la méthode dépendent de la méthode de mise en forme spécifique qui est appelée et du contenu de l’élément de mise en forme, comme suit :The parameters passed to the method depend on the specific formatting method that is called and on the content of the format item, as follows:

Note

L’implémentation de ToString d’un objet est appelée par les méthodes de mise en forme composite uniquement si un fournisseur de format de ICustomFormatter n’est pas passé, ou si la méthode Format du fournisseur de format personnalisé retourne null.An object's ToString implementation is called by composite formatting methods only if they are not passed an ICustomFormatter format provider, or if the Format method of the custom format provider returns null.

Le .NET Framework comprend trois fournisseurs de format, qui implémentent tous l’interface IFormatProvider :The .NET Framework includes three format providers, all of which implement the IFormatProvider interface:

  • NumberFormatInfo fournit des informations de mise en forme numérique, telles que les caractères à utiliser pour les séparateurs décimaux et de groupes, et l’orthographe et le positionnement des symboles monétaires dans les valeurs monétaires.NumberFormatInfo supplies numeric formatting information, such as the characters to use for decimal and group separators, and the spelling and placement of currency symbols in monetary values.

  • DateTimeFormatInfo fournit des informations de mise en forme relatives à la date et à l’heure, telles que la position du mois, le jour et l’année dans un modèle de date.DateTimeFormatInfo supplies date-related and time-related formatting information, such as the position of the month, the day, and the year in a date pattern.

  • CultureInfo contient les informations de mise en forme par défaut dans une culture spécifique, y compris les informations de format numérique, ainsi que les informations de mise en forme relatives à la date et à l’heure.CultureInfo contains the default formatting information in a specific culture, including the numeric format information, and date-related and time-related formatting information.

En outre, vous pouvez définir votre propre fournisseur de format personnalisé.In addition, you can define your own custom format provider.

Notes to Implementers

La méthode ToString(String, IFormatProvider) doit prendre en charge le spécificateur de format "G" (général).The ToString(String, IFormatProvider) method must support the "G" (general) format specifier. Outre le spécificateur « G », la classe peut définir la liste des spécificateurs de format qu’elle prend en charge.Besides the "G" specifier, the class can define the list of format specifiers that it supports. En outre, la classe doit être préparée à gérer un spécificateur de format null.In addition, the class must be prepared to handle a format specifier that is null. Pour plus d’informations sur la mise en forme et la mise en forme des codes, consultez mise en forme des types.For more information about formatting and formatting codes, see Formatting Types.

Applies to

See also