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 Formatspezifizierer: "G" und "C", die angeben, dass die Temperatur in Celsius angezeigt werden soll. "F" gibt an, dass die Temperatur in Fahrenheit angezeigt werden soll. und "K" gibt an, dass die Temperatur in Kelvin angezeigt werden soll.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. Außerdem kann die IFormattable.ToString Implementierung auch eine Format Zeichenfolge verarbeiten, die null oder leer ist.In addition, the IFormattable.ToString implementation also can handle a format string that is null or empty. Die anderen beiden ToString Methoden, die durch Temperature die-Klasse definiert werden, wrappen einfach einen-Rückruf 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

Im folgenden Beispiel wird die IFormattable.ToString Implementierung entweder direkt oder mithilfe einer zusammengesetzten Format Zeichenfolge aufgerufen.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 basierend auf einer Format Zeichenfolge und einem Format Anbieter in seine Zeichen folgen Darstellung.The IFormattable interface converts an object to its string representation based on a format string and a format provider.

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

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

Ein Format Anbieter gibt ein Formatierungs Objekt zurück, das in der Regel die Symbole definiert, mit denen ein Objekt in seine Zeichen folgen Darstellung umgerechnet wird.A format provider returns a formatting object that typically defines the symbols used in converting an object to its string representation. Wenn Sie z. b. eine Zahl in einen Währungswert konvertieren, definiert ein Format Anbieter das Währungssymbol, das in der Ergebnis Zeichenfolge angezeigt wird.For example, when you convert a number to a currency value, a format provider defines the currency symbol that appears in the result string. Der .NET Framework definiert drei Format Anbieter:The .NET Framework defines three format providers:

Außerdem können Sie eigene benutzerdefinierte Format Anbieter definieren, um kulturspezifische, berufsspezifische oder branchenspezifische Informationen anzugeben, die bei der Formatierung verwendet werden.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 benutzerdefinierter Formatierungen mithilfe eines benutzerdefinierten Format Anbieters finden ICustomFormatterSie unter.For more information about implementing custom formatting by using a custom format provider, see ICustomFormatter.

Die IFormattable -Schnittstelle definiert eine einzige ToStringMethode,, die Formatierungs Dienste 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 kann direkt aufgerufen werden.The ToString method can be called directly. Außerdem wird es automatisch von der-Methode und Convert.ToString(Object) der Convert.ToString(Object, IFormatProvider) -Methode sowie von Methoden aufgerufen, die das Feature für die kombinierte Formatierung in der .NET Framework verwenden.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. Zu diesen Methoden Console.WriteLine(String, Object)zählen String.Formatunter anderem StringBuilder.AppendFormat(String, Object), und.Such methods include Console.WriteLine(String, Object), String.Format, and StringBuilder.AppendFormat(String, Object), among others. Die ToString -Methode wird für jedes Format Element in der Format Zeichenfolge der Methode aufgerufen.The ToString method is called for each format item in the method's format string.

Die IFormattable -Schnittstelle wird von den Basis Datentypen implementiert.The IFormattable interface is implemented by the base data types.

Hinweise für Ausführende

Klassen, die mehr Kontrolle über die Formatierung von Zeichen folgen ToString() als bereitstellen IFormattable, sollten implementieren.Classes that require more control over the formatting of strings than ToString() provides should implement IFormattable.

Eine Klasse, die IFormattable implementiert, muss den Format Bezeichner "G" (allgemein) unterstützen.A class that implements IFormattable must support the "G" (general) format specifier. Neben dem "G"-Spezifizierer kann die-Klasse die Liste der Format Bezeichner definieren, die Sie unterstützt.Besides the "G" specifier, the class can define the list of format specifiers that it supports. Außerdem muss die Klasse darauf vorbereitet sein, einen Format Bezeichner zu verarbeiten, der nullist.In addition, the class must be prepared to handle a format specifier that is null. Weitere Informationen zu Formatierungs-und Formatierungscodes finden Sie unter Formatieren von Typen .For 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 unter Verwendung des angegebenen Formats.Formats the value of the current instance using the specified format.

Gilt für:

Siehe auch