IFormatProvider Schnittstelle

Definition

Stellt einen Mechanismus zum Abrufen eines Objekts für die Formatierungssteuerung bereit.Provides a mechanism for retrieving an object to control formatting.

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

Beispiele

Im folgenden Beispiel wird veranschaulicht, wie eine IFormatProvider-Implementierung die Darstellung eines Datums-und Uhrzeitwerts ändern kann.The following example illustrates how an IFormatProvider implementation can change the representation of a date and time value. In diesem Fall wird ein einzelnes Datum mit CultureInfo Objekten angezeigt, die vier verschiedene Kulturen darstellen.In this case, a single date is displayed by using CultureInfo objects that represent four different cultures.

using System;
using System.Globalization;

public class Example
{
   public static void Main()
   {
      DateTime dateValue = new DateTime(2009, 6, 1, 16, 37, 0);
      CultureInfo[] cultures = { new CultureInfo("en-US"), 
                                 new CultureInfo("fr-FR"),
                                 new CultureInfo("it-IT"),
                                 new CultureInfo("de-DE") };
      foreach (CultureInfo culture in cultures)
         Console.WriteLine("{0}: {1}", culture.Name, dateValue.ToString(culture));
   }
}
// The example displays the following output:
//       en-US: 6/1/2009 4:37:00 PM
//       fr-FR: 01/06/2009 16:37:00
//       it-IT: 01/06/2009 16.37.00
//       de-DE: 01.06.2009 16:37:00
Imports System.Globalization

Module Example
   Public Sub Main()
      Dim dateValue As Date = #06/01/2009 4:37PM#
      Dim cultures() As CultureInfo = {New CultureInfo("en-US"), _
                                       New CultureInfo("fr-FR"), _
                                       New CultureInfo("it-IT"), _
                                       New CultureInfo("de-DE") }
      For Each culture As CultureInfo In cultures
         Console.WriteLine("{0}: {1}", culture.Name, dateValue.ToString(culture))
      Next                                        
   End Sub
End Module
' The example displays the following output:
'       en-US: 6/1/2009 4:37:00 PM
'       fr-FR: 01/06/2009 16:37:00
'       it-IT: 01/06/2009 16.37.00
'       de-DE: 01.06.2009 16:37:00

Das folgende Beispiel veranschaulicht die Verwendung einer-Klasse, die die IFormatProvider-Schnittstelle und die GetFormat-Methode implementiert.The following example illustrates the use of a class that implements the IFormatProvider interface and the GetFormat method. Die AcctNumberFormat-Klasse konvertiert einen Int64 Wert, der eine Kontonummer darstellt, in eine formatierte 12-stellige Kontonummer.The AcctNumberFormat class converts an Int64 value that represents an account number to a formatted 12-digit account number. Die GetFormat-Methode gibt einen Verweis auf die aktuelle AcctNumberFormat Instanz zurück, wenn der formatType-Parameter auf eine Klasse verweist, die ICustomFormatterimplementiert. Andernfalls gibt GetFormat nullzurück.Its GetFormat method returns a reference to the current AcctNumberFormat instance if the formatType parameter refers to a class that implements ICustomFormatter; otherwise, GetFormat returns null.

public class AcctNumberFormat : IFormatProvider, ICustomFormatter
{
   private const int ACCT_LENGTH = 12;
   
   public object GetFormat(Type formatType)
   {
      if (formatType == typeof(ICustomFormatter))
         return this;
      else
         return null;
   }
   
   public string Format(string fmt, object arg, IFormatProvider formatProvider) 
   {
      // Provide default formatting if arg is not an Int64.
      if (arg.GetType() != typeof(Int64))
         try {
            return HandleOtherFormats(fmt, arg); 
         }
         catch (FormatException e) {
            throw new FormatException(String.Format("The format of '{0}' is invalid.", fmt), e);
         }
      
      // Provide default formatting for unsupported format strings.
      string ufmt = fmt.ToUpper(CultureInfo.InvariantCulture);
      if (! (ufmt == "H" || ufmt == "I")) 
         try {
            return HandleOtherFormats(fmt, arg);
         }
         catch (FormatException e) {
            throw new FormatException(String.Format("The format of '{0}' is invalid.", fmt), e);
         }
           
      // Convert argument to a string.
      string result = arg.ToString();
      
      // If account number is less than 12 characters, pad with leading zeroes.
      if (result.Length < ACCT_LENGTH)
         result = result.PadLeft(ACCT_LENGTH, '0');
      // If account number is more than 12 characters, truncate to 12 characters.
      if (result.Length > ACCT_LENGTH)
         result = result.Substring(0, ACCT_LENGTH);   

      if (ufmt == "I")                    // Integer-only format. 
         return result;
      // Add hyphens for H format specifier.
      else                                         // Hyphenated format.
         return result.Substring(0, 5) + "-" + result.Substring(5, 3) + "-" + result.Substring(8);
   }

   private string HandleOtherFormats(string format, object arg)
   {
      if (arg is IFormattable) 
         return ((IFormattable)arg).ToString(format, CultureInfo.CurrentCulture);
      else if (arg != null)
         return arg.ToString();
      else
         return String.Empty;
   }
}
Public Class AcctNumberFormat : Implements IFormatProvider, ICustomFormatter

   Private Const ACCT_LENGTH As Integer = 12
   
   Public Function GetFormat(formatType As Type) As Object _
                   Implements IFormatProvider.GetFormat
      If formatType Is GetType(ICustomFormatter) Then
         Return Me
      Else
         Return Nothing
      End If
   End Function
   
   Public Function Format(fmt As String, arg As Object, formatProvider As IFormatProvider) As String _
                          Implements ICustomFormatter.Format

      ' Provide default formatting if arg is not an Int64.
       If Not TypeOf arg Is Int64 Then
         Try 
            Return HandleOtherFormats(fmt, arg) 
         Catch e As FormatException 
            Throw New FormatException(String.Format("The format of '{0}' is invalid.", fmt), e)
         End Try
       End If   
                     
      ' Provider default formatting for unsupported format strings.
      Dim ufmt As String = fmt.ToUpper(CultureInfo.InvariantCulture)
      If Not (ufmt = "H" Or ufmt = "I") Then
         Try
            Return HandleOtherFormats(fmt, arg)
         Catch e As FormatException 
            Throw New FormatException(String.Format("The format of '{0}' is invalid.", fmt), e)
         End Try
      End If   

      ' Convert argument to a string.
      Dim result As String = arg.ToString()
      
      ' If account number is less than 12 characters, pad with leading zeroes.
      If result.Length < ACCT_LENGTH Then result = result.PadLeft(ACCT_LENGTH, "0"c)
      ' If account number is more than 12 characters, truncate to 12 characters.
      If result.Length > ACCT_LENGTH Then result = Left(result, ACCT_LENGTH)   
      
      If ufmt = "I"                              ' Integer-only format.
         Return result
      ' Add hyphens for H format specifier.
      Else                                       ' Hypenated format.
         Return Left(result, 5) & "-" & Mid(result, 6, 3) & "-" & Right(result, 4)
      End If   
   End Function   

   Private Function HandleOtherFormats(fmt As String, arg As Object) As String
      If TypeOf arg Is IFormattable Then
         Return DirectCast(arg, IFormattable).ToString(fmt, CultureInfo.CurrentCulture)
      ElseIf arg IsNot Nothing Then
         Return arg.ToString()
      Else
         Return String.Empty
      End If
   End Function
End Class

Die Klasse, die IFormatProvider implementiert, kann dann in einem Vorgang für einen Formatierungs-und einen Verarbeitungsvorgang verwendet werden.The class that implements IFormatProvider can then be used in a call to a formatting and parsing operation. Der folgende Code ruft z. b. die String.Format(IFormatProvider, String, Object[])-Methode auf, um eine Zeichenfolge zu generieren, die eine formatierte 12-stellige Kontonummer enthält.For example, the following code calls the String.Format(IFormatProvider, String, Object[]) method to generate a string that contains a formatted 12-digit account number.

using System;
using System.Globalization;

public enum DaysOfWeek { Monday=1, Tuesday=2 };

public class TestFormatting
{
   public static void Main()
   {
      long acctNumber;
      double balance; 
      DaysOfWeek wday; 
      string output;

      acctNumber = 104254567890;
      balance = 16.34;
      wday = DaysOfWeek.Monday;

      output = String.Format(new AcctNumberFormat(), 
                             "On {2}, the balance of account {0:H} was {1:C2}.", 
                             acctNumber, balance, wday);
      Console.WriteLine(output);

      wday = DaysOfWeek.Tuesday;
      output = String.Format(new AcctNumberFormat(), 
                             "On {2}, the balance of account {0:I} was {1:C2}.", 
                             acctNumber, balance, wday);
      Console.WriteLine(output);
   }
}
// The example displays the following output:
//       On Monday, the balance of account 10425-456-7890 was $16.34.
//       On Tuesday, the balance of account 104254567890 was $16.34.
Imports System.Globalization

Public Enum DaysOfWeek As Long
   Monday = 1
   Tuesday = 2
End Enum

Module TestFormatting
   Public Sub Main()
      Dim acctNumber As Long, balance As Double 
      Dim wday As DaysOfWeek 
      Dim output As String

      acctNumber = 104254567890
      balance = 16.34
      wday = DaysOfWeek.Monday

      output = String.Format(New AcctNumberFormat(), "On {2}, the balance of account {0:H} was {1:C2}.", acctNumber, balance, wday)
      Console.WriteLine(output)

      wday = DaysOfWeek.Tuesday
      output = String.Format(New AcctNumberFormat(), "On {2}, the balance of account {0:I} was {1:C2}.", acctNumber, balance, wday)
      Console.WriteLine(output)
   End Sub
End Module
' The example displays the following output:
'    On Monday, the balance of account 10425-456-7890 was $16.34.
'    On Tuesday, the balance of account 104254567890 was $16.34.

Hinweise

Die IFormatProvider-Schnittstelle stellt ein Objekt bereit, das Formatierungsinformationen für Formatierungs-und Verarbeitungsvorgänge bereitstellt.The IFormatProvider interface supplies an object that provides formatting information for formatting and parsing operations. Bei Formatierungs Vorgängen wird der Wert eines Typs in die Zeichen folgen Darstellung dieses Werts konvertiert.Formatting operations convert the value of a type to the string representation of that value. Typische Formatierungs Methoden sind die ToString Methoden eines Typs sowie Format.Typical formatting methods are the ToString methods of a type, as well as Format. Beim Durcharbeiten von Vorgängen wird die Zeichen folgen Darstellung eines Werts in einen Typ mit diesem Wert konvertiert.Parsing operations convert the string representation of a value to a type with that value. Typische Methoden für die Methode sind Parse und TryParse.Typical parsing methods are Parse and TryParse.

Die IFormatProvider-Schnittstelle besteht aus einer einzelnen Methode, IFormatProvider.GetFormat.The IFormatProvider interface consists of a single method, IFormatProvider.GetFormat. GetFormat ist eine Rückruf Methode: die Methode zum übermitteln oder formatieren ruft Sie auf und übergibt ihr ein Type Objekt, das den Objekttyp darstellt, der von der Formatierungs-oder der-Methode erwartet wird.GetFormat is a callback method: The parsing or formatting method calls it and passes it a Type object that represents the type of object that the formatting or parsing method expects will provide formatting information. Die GetFormat-Methode ist für die Rückgabe eines Objekts dieses Typs verantwortlich.The GetFormat method is responsible for returning an object of that type.

IFormatProvider-Implementierungen werden oft implizit durch Formatierungs-und Methoden Methoden verwendet.IFormatProvider implementations are often used implicitly by formatting and parsing methods. Beispielsweise verwendet die DateTime.ToString(String)-Methode implizit eine IFormatProvider-Implementierung, die die aktuelle Kultur des Systems darstellt.For example, the DateTime.ToString(String) method implicitly uses an IFormatProvider implementation that represents the system's current culture. IFormatProvider Implementierungen können auch explizit durch Methoden angegeben werden, die über einen Parameter vom Typ "IFormatProvider" verfügen, z. b. Int32.Parse(String, IFormatProvider) und String.Format(IFormatProvider, String, Object[]).IFormatProvider implementations can also be specified explicitly by methods that have a parameter of type IFormatProvider, such as Int32.Parse(String, IFormatProvider) and String.Format(IFormatProvider, String, Object[]).

Die .NET Framework umfasst die folgenden drei vordefinierten IFormatProvider Implementierungen, um kulturspezifische Informationen bereitzustellen, die beim Formatieren oder Auswerten von numerischen Werten und Datums-und Uhrzeitwerten verwendet werden:The .NET Framework includes the following three predefined IFormatProvider implementations to provide culture-specific information that is used in formatting or parsing numeric and date and time values:

  • Die NumberFormatInfo-Klasse, die Informationen bereitstellt, die zum Formatieren von Zahlen verwendet werden, wie z. b. die Währungssymbole, Tausender Trennzeichen und Dezimaltrennzeichen für eine bestimmte Kultur.The NumberFormatInfo class, which provides information that is used to format numbers, such as the currency, thousands separator, and decimal separator symbols for a particular culture. Informationen zu den vordefinierten, von einem NumberFormatInfo Objekt erkannten und in numerischen Formatierungs Vorgängen verwendeten Format Zeichenfolgen finden Sie unter Standard mäßige Zahlenformat Zeichenfolgen und benutzerdefinierte ZahlenformatZeichenfolgenFor information about the predefined format strings recognized by a NumberFormatInfo object and used in numeric formatting operations, see Standard Numeric Format Strings and Custom Numeric Format Strings.

  • Die DateTimeFormatInfo-Klasse, die Informationen bereitstellt, die zum Formatieren von Datums-und Uhrzeitangaben verwendet werden, z. b. die Datums-und Uhrzeit Trennzeichen für eine bestimmte Kultur oder die Reihenfolge und das Format der Komponenten Jahr, Monat und Tag eines Datums.The DateTimeFormatInfo class, which provides information that is used to format dates and times, such as the date and time separator symbols for a particular culture or the order and format of a date's year, month, and day components. Informationen zu den vordefinierten, von einem DateTimeFormatInfo Objekt erkannten und in numerischen Formatierungs Vorgängen verwendeten Format Zeichenfolgen finden Sie unter Standard Format Zeichenfolgen für Datum und Uhrzeit und benutzerdefinierte Format Zeichenfolgen für Datum und UhrzeitFor information about the predefined format strings recognized by a DateTimeFormatInfo object and used in numeric formatting operations, see Standard Date and Time Format Strings and Custom Date and Time Format Strings.

  • Die CultureInfo-Klasse, die eine bestimmte Kultur darstellt.The CultureInfo class, which represents a particular culture. Die GetFormat-Methode gibt ein kulturspezifisches NumberFormatInfo oder DateTimeFormatInfo Objekt zurück, abhängig davon, ob das CultureInfo Objekt in einem Formatierungs-oder einem Verarbeitungsvorgang verwendet wird, das Zahlen oder Datumsangaben und Uhrzeiten umfasst.Its GetFormat method returns a culture-specific NumberFormatInfo or DateTimeFormatInfo object, depending on whether the CultureInfo object is used in a formatting or parsing operation that involves numbers or dates and times.

Der .NET Framework unterstützt auch die benutzerdefinierte Formatierung.The .NET Framework also supports custom formatting. Dies umfasst in der Regel die Erstellung einer Formatierungs Klasse, die sowohl IFormatProvider als auch ICustomFormatterimplementiert.This typically involves the creation of a formatting class that implements both IFormatProvider and ICustomFormatter. Eine Instanz dieser Klasse wird dann als Parameter an eine Methode übergeben, die einen benutzerdefinierten Formatierungs Vorgang ausführt, z. b. String.Format(IFormatProvider, String, Object[]) das Beispiel eine Darstellung einer solchen benutzerdefinierten Implementierung bereitstellt, die eine Zahl als 12-stellige Kontonummer formatiert.An instance of this class is then passed as a parameter to a method that performs a custom formatting operation, such as String.Format(IFormatProvider, String, Object[]) The example provides an illustration of such a custom implementation that formats a number as a 12-digit account number.

Methoden

GetFormat(Type)

Gibt ein Objekt zurück, das Formatierungsdienste für den angegebenen Typ bereitstellt.Returns an object that provides formatting services for the specified type.

Gilt für:

Siehe auch