IFormattable Schnittstelle

Definition

Stellt Funktionen zum Formatieren des Werts eines Objekts als Zeichenfolgendarstellung bereit.

public interface class IFormattable
public interface IFormattable
[System.Runtime.InteropServices.ComVisible(true)]
public interface IFormattable
type IFormattable = interface
[<System.Runtime.InteropServices.ComVisible(true)>]
type IFormattable = interface
Public Interface IFormattable
Abgeleitet
Attribute

Beispiele

Im folgenden Beispiel wird eine Temperature -Klasse definiert, die die IFormattable -Schnittstelle implementiert. Die -Klasse unterstützt vier Formatbezeichner: "G" und "C", die angeben, dass die Temperatur in Celsius angezeigt werden soll. "F", was angibt, dass die Temperatur in Fahrenheit angezeigt werden soll; und "K", was angibt, dass die Temperatur in Kelvin angezeigt werden soll. Darüber hinaus kann die IFormattable.ToString Implementierung auch eine Formatzeichenfolge verarbeiten, die null oder leer ist. Die anderen beiden ToString Methoden, die von der -Klasse definiert werden, Temperature umschließen einfach einen Aufruf der IFormattable.ToString -Implementierung.

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

Im folgenden Beispiel wird die Implementierung dann IFormattable.ToString entweder direkt oder mithilfe einer zusammengesetzten Formatzeichenfolge aufrufen.

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)

Hinweise

Die IFormattable -Schnittstelle konvertiert ein Objekt basierend auf einer Formatzeichenfolge und einem Formatanbieter in seine Zeichenfolgendarstellung.

Eine Formatzeichenfolge definiert in der Regel die allgemeine Darstellung eines Objekts. Die .NET Framework unterstützt beispielsweise Folgendes:

Sie können auch eigene Formatzeichenfolgen definieren, um die Formatierung ihrer anwendungsdefinierte Typen zu unterstützen.

Ein Formatanbieter gibt ein Formatierungsobjekt zurück, das in der Regel die Symbole definiert, die beim Konvertieren eines Objekts in seine Zeichenfolgendarstellung verwendet werden. Wenn Sie beispielsweise eine Zahl in einen Währungswert konvertieren, definiert ein Formatanbieter das Währungssymbol, das in der Ergebniszeichenfolge angezeigt wird. Der .NET Framework definiert drei Formatanbieter:

Darüber hinaus können Sie ihre eigenen benutzerdefinierten Formatanbieter definieren, um kulturspezifische, unternehmensspezifische oder branchenspezifische Informationen für die Formatierung zur Verfügung zu stellen. Weitere Informationen zum Implementieren einer benutzerdefinierten Formatierung mithilfe eines benutzerdefinierten Formatanbieters finden Sie unter ICustomFormatter .

Die IFormattable -Schnittstelle definiert eine einzelne Methode, ToString , die Formatierungsdienste für den implementierenden Typ anbietet. Die ToString -Methode kann direkt aufgerufen werden. Darüber hinaus wird es automatisch von den Convert.ToString(Object) Methoden und sowie von Methoden Convert.ToString(Object, IFormatProvider) aufgerufen, die das Feature für die zusammengesetzte Formatierung im .NET Framework verwenden. Zu diesen Methoden gehören Console.WriteLine(String, Object) unter anderem , und String.Format StringBuilder.AppendFormat(String, Object) . Die ToString -Methode wird für jedes Formatelement in der Formatzeichenfolge der Methode aufgerufen.

Die IFormattable -Schnittstelle wird von den Basisdatentypen implementiert.

Hinweise für Ausführende

Klassen, die mehr Kontrolle über die Formatierung von Zeichenfolgen benötigen, als ToString() bereitstellt, sollten IFormattable implementieren.

Eine Klasse, die implementiert, IFormattable muss den Formatbezeichner "G" (allgemein) unterstützen. Neben dem "G"-Bezeichner kann die Klasse die Liste der unterstützten Formatbezeichner definieren. Darüber hinaus muss die -Klasse darauf vorbereitet sein, einen Formatbezeichner zu behandeln, der null ist. Weitere Informationen zum Formatieren und Formatieren von Codes finden Sie unter Formatieren von Typen.

Methoden

ToString(String, IFormatProvider)

Formatiert den Wert der aktuellen Instanz mit dem angegebenen Format.

Gilt für

Siehe auch