IFormattable IFormattable IFormattable IFormattable Interface

Definizione

Fornisce funzionalità per formattare il valore di un oggetto in una rappresentazione di stringa.Provides functionality to format the value of an object into a string representation.

public interface class IFormattable
[System.Runtime.InteropServices.ComVisible(true)]
public interface IFormattable
type IFormattable = interface
Public Interface IFormattable
Derivato
Attributi

Esempi

Nell'esempio seguente viene definita una classe Temperature che implementa l'interfaccia IFormattable .The following example defines a Temperature class that implements the IFormattable interface. La classe supporta quattro identificatori di formato: "G" e "C", che indicano che la temperatura deve essere visualizzato in Celsius; "F", che indica che la temperatura è da visualizzare in gradi Fahrenheit; e "K", che indica che la temperatura deve essere visualizzato in Kelvin.The class supports four format specifiers: "G" and "C", which indicate that the temperature is to be displayed in Celsius; "F", which indicates that the temperature is to be displayed in Fahrenheit; and "K", which indicates that the temperature is to be displayed in Kelvin. Inoltre, il IFormattable.ToString implementazione possa gestire anche una stringa di formato è null o vuoto.In addition, the IFormattable.ToString implementation also can handle a format string that is null or empty. Gli altri due ToString metodi definiti dal Temperature classe semplicemente il wrapping di una chiamata al IFormattable.ToString implementazione.The other two ToString methods defined by the Temperature class simply wrap a call to the IFormattable.ToString implementation.

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

L'esempio seguente chiama quindi il IFormattable.ToString implementazione direttamente o tramite una stringa di formato composito.The following example then calls the IFormattable.ToString implementation either directly or by using a composite format string.

public class Example
{
   public static void Main()
   {
      // Use composite formatting with format string in the format item.
      Temperature temp1 = new Temperature(0);
      Console.WriteLine("{0:C} (Celsius) = {0:K} (Kelvin) = {0:F} (Fahrenheit)\n", temp1);
      
      // Use composite formatting with a format provider.
      temp1 = new Temperature(-40);
      Console.WriteLine(String.Format(CultureInfo.CurrentCulture, "{0:C} (Celsius) = {0:K} (Kelvin) = {0:F} (Fahrenheit)", temp1));
      Console.WriteLine(String.Format(new CultureInfo("fr-FR"), "{0:C} (Celsius) = {0:K} (Kelvin) = {0:F} (Fahrenheit)\n", temp1));
      
      // Call ToString method with format string.
      temp1 = new Temperature(32);
      Console.WriteLine("{0} (Celsius) = {1} (Kelvin) = {2} (Fahrenheit)\n", 
                        temp1.ToString("C"), temp1.ToString("K"), temp1.ToString("F"));

      // Call ToString with format string and format provider
      temp1 = new Temperature(100)      ;
      NumberFormatInfo current = NumberFormatInfo.CurrentInfo;
      CultureInfo nl = new CultureInfo("nl-NL"); 
      Console.WriteLine("{0} (Celsius) = {1} (Kelvin) = {2} (Fahrenheit)", 
                        temp1.ToString("C", current), temp1.ToString("K", current), temp1.ToString("F", current));
      Console.WriteLine("{0} (Celsius) = {1} (Kelvin) = {2} (Fahrenheit)", 
                        temp1.ToString("C", nl), temp1.ToString("K", nl), temp1.ToString("F", nl));
   }
}
// The example displays the following output:
//    0.00 °C (Celsius) = 273.15 K (Kelvin) = 32.00 °F (Fahrenheit)
//    
//    -40.00 °C (Celsius) = 233.15 K (Kelvin) = -40.00 °F (Fahrenheit)
//    -40,00 °C (Celsius) = 233,15 K (Kelvin) = -40,00 °F (Fahrenheit)
//    
//    32.00 °C (Celsius) = 305.15 K (Kelvin) = 89.60 °F (Fahrenheit)
//    
//    100.00 °C (Celsius) = 373.15 K (Kelvin) = 212.00 °F (Fahrenheit)
//    100,00 °C (Celsius) = 373,15 K (Kelvin) = 212,00 °F (Fahrenheit)
Module Example
   Public Sub Main()
      ' Use composite formatting with format string in the format item.
      Dim temp1 As New Temperature(0)
      Console.WriteLine("{0:C} (Celsius) = {0:K} (Kelvin) = {0:F} (Fahrenheit)", temp1)
      Console.WriteLine()
      
      ' Use composite formatting with a format provider.
      temp1 = New Temperature(-40)
      Console.WriteLine(String.Format(CultureInfo.CurrentCulture, "{0:C} (Celsius) = {0:K} (Kelvin) = {0:F} (Fahrenheit)", temp1))
      Console.WriteLine(String.Format(New CultureInfo("fr-FR"), "{0:C} (Celsius) = {0:K} (Kelvin) = {0:F} (Fahrenheit)", temp1))
      Console.WriteLine()
      
      ' Call ToString method with format string.
      temp1 = New Temperature(32)
      Console.WriteLine("{0} (Celsius) = {1} (Kelvin) = {2} (Fahrenheit)", _
                        temp1.ToString("C"), temp1.ToString("K"), temp1.ToString("F"))
      Console.WriteLine()

      ' Call ToString with format string and format provider
      temp1 = New Temperature(100)      
      Dim current As NumberFormatInfo = NumberFormatInfo.CurrentInfo
      Dim nl As New CultureInfo("nl-NL") 
      Console.WriteLine("{0} (Celsius) = {1} (Kelvin) = {2} (Fahrenheit)", _
                        temp1.ToString("C", current), temp1.ToString("K", current), temp1.ToString("F", current))
      Console.WriteLine("{0} (Celsius) = {1} (Kelvin) = {2} (Fahrenheit)", _
                        temp1.ToString("C", nl), temp1.ToString("K", nl), temp1.ToString("F", nl))
   End Sub
End Module
' The example displays the following output:
'       0.00 °C (Celsius) = 273.15 K (Kelvin) = 32.00 °F (Fahrenheit)
'       
'       -40.00 °C (Celsius) = 233.15 K (Kelvin) = -40.00 °F (Fahrenheit)
'       -40,00 °C (Celsius) = 233,15 K (Kelvin) = -40,00 °F (Fahrenheit)
'       
'       32.00 °C (Celsius) = 305.15 K (Kelvin) = 89.60 °F (Fahrenheit)
'       
'       100.00 °C (Celsius) = 373.15 K (Kelvin) = 212.00 °F (Fahrenheit)
'       100,00 °C (Celsius) = 373,15 K (Kelvin) = 212,00 °F (Fahrenheit)

Commenti

Il IFormattable interfaccia converte un oggetto alla relativa rappresentazione di stringa basate su una stringa di formato e un provider di formato.The IFormattable interface converts an object to its string representation based on a format string and a format provider.

In genere, una stringa di formato definisce l'aspetto generale di un oggetto.A format string typically defines the general appearance of an object. Ad esempio, .NET Framework supporta quanto segue:For example, the .NET Framework supports the following:

È anche possibile definire stringhe di formato per supportare la formattazione dei tipi definiti dall'applicazione.You can also define your own format strings to support formatting of your application-defined types.

Un provider di formato restituisce un oggetto di formattazione che in genere definisce i simboli usati nella conversione di un oggetto alla relativa rappresentazione di stringa.A format provider returns a formatting object that typically defines the symbols used in converting an object to its string representation. Ad esempio, quando si converte un numero in un valore di valuta, un provider di formato definisce il simbolo di valuta che appare nella stringa di risultato.For example, when you convert a number to a currency value, a format provider defines the currency symbol that appears in the result string. .NET Framework definisce tre provider di formato:The .NET Framework defines three format providers:

Inoltre, è possibile definire i propri provider di formato personalizzato per fornire impostazioni cultura specifiche, professione specifico, o informazioni specifiche del settore utilizzato per la formattazione.In addition, you can define your own custom format providers to supply culture-specific, profession-specific, or industry-specific information used in formatting. Per altre informazioni sull'implementazione di formattazione personalizzata mediante un provider di formato personalizzato, vedere ICustomFormatter.For more information about implementing custom formatting by using a custom format provider, see ICustomFormatter.

Il IFormattable interfaccia definisce un singolo metodo, ToString, che fornisce servizi di formattazione per il tipo di implementazione.The IFormattable interface defines a single method, ToString, that supplies formatting services for the implementing type. Il ToString metodo può essere chiamato direttamente.The ToString method can be called directly. Inoltre, viene chiamato automaticamente dal Convert.ToString(Object) e Convert.ToString(Object, IFormatProvider) metodi e dai metodi che utilizzano il funzionalità di formattazione composita in .NET Framework.In addition, it is 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. Tali metodi includono Console.WriteLine(String, Object), String.Format, e StringBuilder.AppendFormat(String, Object), tra gli altri.Such methods include Console.WriteLine(String, Object), String.Format, and StringBuilder.AppendFormat(String, Object), among others. Il ToString viene chiamato per ogni elemento nella stringa di formato del metodo.The ToString method is called for each format item in the method's format string.

Il IFormattable interfaccia viene implementata dai tipi di dati di base.The IFormattable interface is implemented by the base data types.

Note per gli implementatori

Le classi che richiedono un maggiore controllo sulla formattazione delle stringhe rispetto alla ToString() fornisce devono implementare IFormattable.Classes that require more control over the formatting of strings than ToString() provides should implement IFormattable.

Una classe che implementa IFormattable deve supportare l'identificatore di formato (generale) "G".A class that implements IFormattable must support the "G" (general) format specifier. Oltre l'identificatore "G", la classe può definire l'elenco di identificatori di formato che supporta.Besides the "G" specifier, the class can define the list of format specifiers that it supports. Inoltre, la classe deve essere preparata per gestire un identificatore di formato è null.In addition, the class must be prepared to handle a format specifier that is null. Per altre informazioni sulla formattazione e codici di formattazione, vedere formattazione di tipiFor more information about formatting and formatting codes, see Formatting Types

Metodi

ToString(String, IFormatProvider) ToString(String, IFormatProvider) ToString(String, IFormatProvider) ToString(String, IFormatProvider)

Formatta il valore dell'istanza corrente usando il formato specificato.Formats the value of the current instance using the specified format.

Si applica a

Vedi anche