IFormattable IFormattable IFormattable IFormattable Interface

Definition

Stellt Funktionen zum Formatieren des Werts eines Objekts als Zeichenfolgendarstellung bereit.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
Abgeleitet
Attribute

Beispiele

Im folgenden Beispiel wird eine Temperature -Klasse definiert, die die IFormattable -Schnittstelle implementiert.The following example defines a Temperature class that implements the IFormattable interface. Die Klasse unterstützt vier Formatbezeichner: "G" und "C", die darauf hinweisen, dass die Temperatur in Grad Celsius; angezeigt werden "F", der angibt, dass die Temperatur in Fahrenheit angezeigt werden; und "K", der angibt, dass die Temperatur in Kelvin angezeigt werden.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. Darüber hinaus die IFormattable.ToString Implementierung kann auch eine Zeichenfolge, die behandeln null oder leer sein.In addition, the IFormattable.ToString implementation also can handle a format string that is null or empty. Die anderen beiden ToString definierten Methoden den Temperature Klasse einfach einen Wrapper für einen Aufruf der IFormattable.ToString Implementierung.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

Das folgende Beispiel ruft dann die IFormattable.ToString Implementierung entweder direkt oder über eine kombinierte Formatzeichenfolge.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)

Hinweise

Die IFormattable Schnittstelle konvertiert ein Objekt in seine Zeichenfolgendarstellung, die basierend auf einer Formatzeichenfolge und einen Formatanbieter.The IFormattable interface converts an object to its string representation based on a format string and a format provider.

Eine Formatzeichenfolge definiert in der Regel die allgemeine Darstellung eines Objekts.A format string typically defines the general appearance of an object. .NET Framework unterstützt z. B. Folgendes:For example, the .NET Framework supports the following:

Sie können auch eigene Formatzeichenfolgen um unterstützen die Formatierung der Anwendung definierte Typen definieren.You can also define your own format strings to support formatting of your application-defined types.

Ein Formatanbieter gibt ein Formatierungsobjekt, die in der Regel verwendeten Symbole definiert, in ein Objekt in seine Zeichenfolgendarstellung konvertiert.A format provider returns a formatting object that typically defines the symbols used in converting an object to its string representation. Wenn Sie eine Zahl als Währungswert konvertieren, definiert einen Formatanbieter z. B. das Währungssymbol, das angezeigt wird in der Ergebniszeichenfolge.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 definiert drei Formatanbieter an:The .NET Framework defines three format providers:

Darüber hinaus können Sie Ihre eigenen benutzerdefinierten Formatanbieter zum Bereitstellen von kulturspezifischen, Beruf-spezifisch ist, definieren oder Branche-spezifische Informationen, die bei der Formatierung verwendete.In addition, you can define your own custom format providers to supply culture-specific, profession-specific, or industry-specific information used in formatting. Weitere Informationen zum Implementieren von benutzerdefinierten Formatierung durch die Verwendung eines benutzerdefinierten Formatanbieters finden Sie unter ICustomFormatter.For more information about implementing custom formatting by using a custom format provider, see ICustomFormatter.

Die IFormattable Schnittstelle definiert eine einzelne Methode, ToString, Formatierungsdienste für den implementierenden Typ bereitstellt.The IFormattable interface defines a single method, ToString, that supplies formatting services for the implementing type. Die ToString -Methode direkt aufgerufen werden kann.The ToString method can be called directly. Darüber hinaus heißt es automatisch von der Convert.ToString(Object) und Convert.ToString(Object, IFormatProvider) Methoden und durch Methoden, mit denen die Funktion für kombinierte Formatierung 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. Diese Methoden umfassen Console.WriteLine(String, Object), String.Format, und StringBuilder.AppendFormat(String, Object), u. a..Such methods include Console.WriteLine(String, Object), String.Format, and StringBuilder.AppendFormat(String, Object), among others. Die ToString -Methode für jedes Formatelement in Formatzeichenfolge der Methode aufgerufen wird.The ToString method is called for each format item in the method's format string.

Die IFormattable Schnittstelle wird durch die Basisdatentypen implementiert.The IFormattable interface is implemented by the base data types.

Hinweise für Ausführende

Klassen, die mehr Kontrolle über die Formatierung von Zeichenfolgen als benötigen ToString() stellt implementieren sollten IFormattable.Classes that require more control over the formatting of strings than ToString() provides should implement IFormattable.

Eine Klasse, die implementiert IFormattable muss den (Allgemein) Formatbezeichner "G" unterstützen.A class that implements IFormattable must support the "G" (general) format specifier. Neben der Formatbezeichner "G" kann die Klasse die Liste der Formatbezeichner definieren, die es unterstützt.Besides the "G" specifier, the class can define the list of format specifiers that it supports. Darüber hinaus muss die Klasse vorbereitet werden, einen Formatbezeichner, um behandeln null.In addition, the class must be prepared to handle a format specifier that is null. Weitere Informationen zur Formatierung und Formatierungscodes finden Sie unter Formatierung von TypenFor more information about formatting and formatting codes, see Formatting Types

Methoden

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

Formatiert den Wert der aktuellen Instanz mit dem angegebenen Format.Formats the value of the current instance using the specified format.

Gilt für:

Siehe auch