ICustomFormatter Schnittstelle

Definition

Definiert eine Methode, die die benutzerdefinierte Formatierung des Werts eines Objekts unterstützt.Defines a method that supports custom formatting of the value of an object.

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

Beispiele

Im folgenden Beispiel wird ICustomFormatter implementiert, um die binäre, oktale und hexadezimale Formatierung von ganzzahligen Werten zuzulassen.The following example implements ICustomFormatter to allow binary, octal, and hexadecimal formatting of integral values. In diesem Beispiel implementiert eine einzelne Klasse, IBinaryFormatter, sowohl ICustomFormatter als auch IFormatProvider.In this example, a single class, IBinaryFormatter, implements both ICustomFormatter and IFormatProvider. Die- formatType ICustomFormatterMethodebestimmt , ob der Parameter einen-Typ darstellt. IFormatProvider.GetFormatIts IFormatProvider.GetFormat method determines whether the formatType parameter represents an ICustomFormatter type. Wenn dies der Fall BinaryFormatter ist, wird eine Instanz von sich selbst zurückgegeben null; andernfalls wird zurückgegeben.If it does, BinaryFormatter returns an instance of itself; otherwise, it returns null. Die Implementierung bestimmt, ob der Format-Parameter eine der drei unterstützten Format Zeichenfolgen ("B" für "Binary", "O" für oktal und "H" für hexadezimale) ist und den arg Parameter entsprechend formatiert. ICustomFormatter.FormatIts ICustomFormatter.Format implementation determines whether the format parameter is one of the three supported format strings ("B" for binary, "O" for octal, and "H" for hexadecimal) and formats the arg parameter appropriately. Andernfalls, wenn arg nicht nullist, wird die- arg Implementierung des IFormattable.ToString Parameters, sofern vorhanden, oder die Parameter lose ToString -Methode aufgerufen, sofern dies nicht der Fall ist.Otherwise, if arg is not null, it calls the arg parameter's IFormattable.ToString implementation, if one exists, or its parameterless ToString method, if one does not. Wenn arg gleich null ist, gibt die Methode String.Empty zurück.If arg is null, the method returns String.Empty.

using System;
using System.Globalization;
using System.Numerics;

public class BinaryFormatter : IFormatProvider, ICustomFormatter
{
   // IFormatProvider.GetFormat implementation.
   public object GetFormat(Type formatType)
   {
      // Determine whether custom formatting object is requested.
      if (formatType == typeof(ICustomFormatter))
         return this;
      else
         return null;
   }   

   // Format number in binary (B), octal (O), or hexadecimal (H).
   public string Format(string format, object arg, IFormatProvider formatProvider)
   {
      // Handle format string.
      int baseNumber;
      // Handle null or empty format string, string with precision specifier.
      string thisFmt = String.Empty;
      // Extract first character of format string (precision specifiers
      // are not supported).
      if (! String.IsNullOrEmpty(format))
         thisFmt = format.Length > 1 ? format.Substring(0, 1) : format;
         

      // Get a byte array representing the numeric value.
      byte[] bytes;
      if (arg is sbyte)
      {
         string byteString = ((sbyte) arg).ToString("X2");
         bytes = new byte[1] { Byte.Parse(byteString, System.Globalization.NumberStyles.HexNumber ) };
      }
      else if (arg is byte) {
         bytes = new byte[1] { (byte) arg };
      }   
      else if (arg is short) {
         bytes = BitConverter.GetBytes((short) arg);
      }   
      else if (arg is int) {
         bytes = BitConverter.GetBytes((int) arg);
      }   
      else if (arg is long) {
         bytes = BitConverter.GetBytes((long) arg);
      }
      else if (arg is ushort) {
         bytes = BitConverter.GetBytes((ushort) arg);
      }
      else if (arg is uint) {
         bytes = BitConverter.GetBytes((uint) arg);
      }
      else if (arg is ulong) {
         bytes = BitConverter.GetBytes((ulong) arg);                  
      }
      else if (arg is BigInteger) {
         bytes = ((BigInteger) arg).ToByteArray();
      }
      else {
         try {
            return HandleOtherFormats(format, arg); 
         }
         catch (FormatException e) {
            throw new FormatException(String.Format("The format of '{0}' is invalid.", format), e);
         }
      }

      switch (thisFmt.ToUpper())
      {
         // Binary formatting.
         case "B":
            baseNumber = 2;
            break;        
         case "O":
            baseNumber = 8;
            break;
         case "H":
            baseNumber = 16;
            break;
         // Handle unsupported format strings.
         default:
         try {
            return HandleOtherFormats(format, arg); 
         }
         catch (FormatException e) {
            throw new FormatException(String.Format("The format of '{0}' is invalid.", format), e);
         }
      }
   
      // Return a formatted string.
      string numericString = String.Empty;
      for (int ctr = bytes.GetUpperBound(0); ctr >= bytes.GetLowerBound(0); ctr--)
      {
         string byteString = Convert.ToString(bytes[ctr], baseNumber);
         if (baseNumber == 2)
            byteString = new String('0', 8 - byteString.Length) + byteString;
         else if (baseNumber == 8)
            byteString = new String('0', 4 - byteString.Length) + byteString;
         // Base is 16.
         else     
            byteString = new String('0', 2 - byteString.Length) + byteString;

         numericString +=  byteString + " ";
      }
      return numericString.Trim();
   }

   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;
   }
}
Imports System.Globalization
Imports System.Numerics

Public Class BinaryFormatter : Implements IFormatProvider, ICustomFormatter
   ' IFormatProvider.GetFormat implementation.
   Public Function GetFormat(formatType As Type) As Object _
                   Implements IFormatProvider.GetFormat
      ' Determine whether custom formatting object is requested.
      If formatType Is GetType(ICustomFormatter) Then
         Return Me
      Else
         Return Nothing
      End If
   End Function   

   ' Format number in binary (B), octal (O), or hexadecimal (H).
   Public Function Format(fmt As String, arg As Object, _
                          formatProvider As IFormatProvider) As String _
                   Implements ICustomFormatter.Format

     ' Handle format string.
      Dim base As Integer
      ' Handle null or empty format string, string with precision specifier.
      Dim thisFmt As String = String.Empty
      ' Extract first character of format string (precision specifiers
      ' are not supported by BinaryFormatter).
      If Not String.IsNullOrEmpty(fmt) Then
         thisFmt = CStr(IIf(fmt.Length > 1, fmt.Substring(0, 1), fmt))
      End If
         


      ' Get a byte array representing the numeric value.
      Dim bytes() As Byte
      If TypeOf(arg) Is SByte Then
         Dim byteString As String = CType(arg, SByte).ToString("X2")
         bytes = New Byte(0) { Byte.Parse(byteString, System.Globalization.NumberStyles.HexNumber ) }
      ElseIf TypeOf(arg) Is Byte Then
         bytes = New Byte(0) { CType(arg, Byte) }
      ElseIf TypeOf(arg) Is Int16 Then
         bytes = BitConverter.GetBytes(CType(arg, Int16))
      ElseIf TypeOf(arg) Is Int32 Then
         bytes = BitConverter.GetBytes(CType(arg, Int32))
      ElseIf TypeOf(arg) Is Int64 Then
         bytes = BitConverter.GetBytes(CType(arg, Int64))
      ElseIf TypeOf(arg) Is UInt16 Then
         bytes = BitConverter.GetBytes(CType(arg, UInt16))
      ElseIf TypeOf(arg) Is UInt32 Then
         bytes = BitConverter.GetBytes(CType(arg, UInt64))
      ElseIf TypeOf(arg) Is UInt64 Then
         bytes = BitConverter.GetBytes(CType(arg, UInt64))                  
      ElseIf TypeOf(arg) Is BigInteger Then
         bytes = CType(arg, BigInteger).ToByteArray()
      Else
         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

      Select Case thisFmt.ToUpper()
         ' Binary formatting.
         Case "B"
            base = 2        
         Case "O"
            base = 8
         Case "H"
            base = 16
         ' Handle unsupported format strings.
         Case Else
            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 Select
      
      ' Return a formatted string.
      Dim numericString As String = String.Empty
      For ctr As Integer = bytes.GetUpperBound(0) To bytes.GetLowerBound(0) Step -1
         Dim byteString As String = Convert.ToString(bytes(ctr), base)
         If base = 2 Then
            byteString = New String("0"c, 8 - byteString.Length) + byteString
         ElseIf base = 8 Then
            byteString = New String("0"c, 4 - byteString.Length) + byteString
         ' Base is 16.
         Else     
            byteString = New String("0"c, 2 - byteString.Length) + byteString
         End If
         numericString +=  byteString + " "
      Next
      Return numericString.Trim()
   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

BinaryFormatterkann dann verwendet werden, um eine benutzerdefinierte Formatierung bereit BinaryFormatter zustellen, indem provider ein-Objekt Format als Parameter der-Methode übergeben wird, wie im folgenden Beispiel gezeigt.BinaryFormatter can then be used to provide custom formatting by passing a BinaryFormatter object as the provider parameter of the Format method, as the following example shows.

public class Example
{
   public static void Main()
   {
      Console.WindowWidth = 100;
      
      byte byteValue = 124;
      Console.WriteLine(String.Format(new BinaryFormatter(), 
                                      "{0} (binary: {0:B}) (hex: {0:H})", byteValue));
      
      int intValue = 23045;
      Console.WriteLine(String.Format(new BinaryFormatter(), 
                                      "{0} (binary: {0:B}) (hex: {0:H})", intValue));
      
      ulong ulngValue = 31906574882;
      Console.WriteLine(String.Format(new BinaryFormatter(), 
                                      "{0}\n   (binary: {0:B})\n   (hex: {0:H})", 
                                      ulngValue));

      BigInteger bigIntValue = BigInteger.Multiply(Int64.MaxValue, 2);
      Console.WriteLine(String.Format(new BinaryFormatter(), 
                                      "{0}\n   (binary: {0:B})\n   (hex: {0:H})", 
                                      bigIntValue));
   }
}
// The example displays the following output:
//    124 (binary: 01111100) (hex: 7c)
//    23045 (binary: 00000000 00000000 01011010 00000101) (hex: 00 00 5a 05)
//    31906574882
//       (binary: 00000000 00000000 00000000 00000111 01101101 11000111 10110010 00100010)
//       (hex: 00 00 00 07 6d c7 b2 22)
//    18446744073709551614
//       (binary: 00000000 11111111 11111111 11111111 11111111 11111111 11111111 11111111 11111110)
//       (hex: 00 ff ff ff ff ff ff ff fe)
Public Module Example
   Public Sub Main
      Console.WindowWidth = 100
      
      Dim byteValue As Byte = 124
      Console.WriteLine(String.Format(New BinaryFormatter(), _
                                      "{0} (binary: {0:B}) (hex: {0:H})", byteValue))
      
      Dim intValue As Integer = 23045
      Console.WriteLine(String.Format(New BinaryFormatter(), _
                                      "{0} (binary: {0:B}) (hex: {0:H})", intValue))
      
      Dim ulngValue As ULong = 31906574882
      Console.WriteLine(String.Format(New BinaryFormatter(), _
                                      "{0} {1}   (binary: {0:B}) {1}   (hex: {0:H})", _
                                      ulngValue, vbCrLf))

      Dim bigIntValue As BigInteger = BigInteger.Multiply(Int64.MaxValue, 2)
      Console.WriteLine(String.Format(New BinaryFormatter(), _
                                      "{0} {1}   (binary: {0:B}) {1}   (hex: {0:H})", _
                                      bigIntValue, vbCrLf))
   End Sub
End Module
' The example displays the following output:
'    124 (binary: 01111100) (hex: 7c)
'    23045 (binary: 00000000 00000000 01011010 00000101) (hex: 00 00 5a 05)
'    31906574882
'       (binary: 00000000 00000000 00000000 00000111 01101101 11000111 10110010 00100010)
'       (hex: 00 00 00 07 6d c7 b2 22)
'    18446744073709551614
'       (binary: 00000000 11111111 11111111 11111111 11111111 11111111 11111111 11111111 11111110)
'       (hex: 00 ff ff ff ff ff ff ff fe)

Hinweise

Die ICustomFormatter -Schnittstelle enthält eine einzige ICustomFormatter.FormatMethode,.The ICustomFormatter interface includes a single method, ICustomFormatter.Format. Wenn diese Schnittstelle durch einen Verweis-oder Werttyp implementiert Format wird, gibt die Methode eine benutzerdefinierte Zeichen folgen Darstellung des Werts eines Objekts zurück.When this interface is implemented by a reference or value type, the Format method returns a custom-formatted string representation of an object's value.

Normalerweise wird ICustomFormatter die-Schnittstelle mit IFormatProvider der-Schnittstelle implementiert, um das Verhalten von zwei .NET Framework Methoden zur kombinierten IFormatProvider Zeichen folgen Formatierung anzupassen, die einen-Parameter enthalten.Typically, the ICustomFormatter interface is implemented with the IFormatProvider interface to customize the behavior of two .NET Framework composite string formatting methods that include an IFormatProvider parameter. Insbesondere kann die ICustomFormatter -Schnittstelle eine benutzerdefinierte Formatierung des Werts eines Objekts bereitstellen, String.Format(IFormatProvider, String, Object[]) das StringBuilder.AppendFormat(IFormatProvider, String, Object[]) an die Methoden und übertragen wird.Specifically, the ICustomFormatter interface can provide custom formatting of the value of an object passed to the String.Format(IFormatProvider, String, Object[]) and StringBuilder.AppendFormat(IFormatProvider, String, Object[]) methods.

Zum Bereitstellen einer benutzerdefinierten Darstellung des Werts eines Objekts müssen Sie die folgenden Schritte ausführen:Providing a custom representation of an object's value requires that you do the following:

  1. Definieren Sie eine Klasse, die ICustomFormatter die-Schnittstelle und ihren einzelnen Format Member implementiert (die-Methode).Define a class that implements the ICustomFormatter interface and its single member, the Format method.

  2. Definieren Sie eine Klasse, die IFormatProvider die-Schnittstelle und ihren einzelnen GetFormat Member implementiert (die-Methode).Define a class that implements the IFormatProvider interface and its single member, the GetFormat method. Die GetFormat -Methode gibt eine Instanz ICustomFormatter der-Implementierung zurück.The GetFormat method returns an instance of your ICustomFormatter implementation. Häufig implementiert eine einzelne Klasse sowohl ICustomFormatter als auch. IFormatProviderOften, a single class implements both ICustomFormatter and IFormatProvider. In diesem Fall gibt die- GetFormat Implementierung der Klasse nur eine Instanz von sich selbst zurück.In that case, the class's GetFormat implementation just returns an instance of itself.

  3. Übergeben Sie IFormatProvider die-Implementierung provider als Argument der String.Format(IFormatProvider, String, Object[]) -Methode oder einer vergleichbaren Methode.Pass the IFormatProvider implementation as the provider argument of the String.Format(IFormatProvider, String, Object[]) method or a comparable method.

Die .NET Framework-Methode verwendet dann die benutzerdefinierte Formatierung anstelle ihrer eigenen.The .NET Framework method will then use your custom formatting instead of its own.

Hinweise für Ausführende

Der Common Language Runtime versucht, die ICustomFormatter Implementierung für jedes Format Element in einer zusammengesetzten Format Zeichenfolge zu verwenden.The common language runtime attempts to use your ICustomFormatter implementation for every format item in a composite format string. Daher sollten Sie davon ausgehen, dass Ihre ICustomFormatter -Implementierung aufgerufen wird, um Formatierungs Dienste für Objekte oder Werte bereitzustellen, die nicht verarbeitet werden sollen.As a result, you should expect that your ICustomFormatter implementation will be called to provide formatting services to objects or values that it is not designed to handle. In diesen Fällen Format(String, Object, IFormatProvider) muss die-Methode die entsprechende Formatierungs Methode für dieses Objekt oder den Wert aufruft.In these cases, your Format(String, Object, IFormatProvider) method must call the appropriate formatting method for that object or value.

Es gibt zwei Arten von ICustomFormatter Implementierungen: systeminterne Erweiterungen und Erweiterungen.There are two kinds of ICustomFormatter implementations: intrinsic and extension.

Systeminterne Implementierungen sind Implementierungen, die eine benutzerdefinierte Formatierung für ein Anwendungs definiertes Objekt bereitstellen.Intrinsic implementations are implementations that provide custom formatting for an application-defined object. In diesem Fall sollte die Implementierung Folgendes umfassen:In this case, your implementation should include the following: : Eine Definition von Format Zeichenfolgen, die die Formatierung des-Objekts definieren.- A definition of format strings that define the formatting of the object. Format Zeichenfolgen sind optional.Format strings are optional. Normalerweise definiert eine Format Zeichenfolge "g" oder "g" das allgemeine Format (oder das am häufigsten verwendete Format).Typically, a "G" or "g" format string defines the general (or most commonly used) format. Allerdings können Sie beliebige Format Zeichenfolgen definieren, die Sie auswählen.However, you are free to define any format strings that you choose. Außerdem können Sie entscheiden, ob die Groß-/Kleinschreibung beachtet werden soll.You are also free to decide whether they are case-sensitive or case-insensitive.

-Ein Test, um sicherzustellen, dass der Typ des Objekts, Format(String, Object, IFormatProvider) das an Ihre Methode übertragen wird, der von der Anwendung definierte Typ ist.- A test to ensure that the type of the object passed to your Format(String, Object, IFormatProvider) method is your application-defined type. Wenn dies nicht der Fall ist, sollten Sie die- IFormattable Implementierung des Objekts, sofern vorhanden, ToString() oder die zugehörige-Methode (sofern vorhanden) aufzurufen.If it is not, you should call the object's IFormattable implementation, if one exists, or its ToString() method, if it does not. Sie sollten darauf vorbereitet sein, alle Ausnahmen zu behandeln, die von diesen Methoden aufrufen ausgelöst werden können.You should be prepared to handle any exceptions these method calls might throw.

-Code, der eine NULL-Format Zeichenfolge behandelt, wenn die Implementierung Format Zeichenfolgen unterstützt.- Code to handle a null format string, if your implementation supports format strings. Der gängigste Ansatz besteht darin, eine NULL-Format Zeichenfolge durch den allgemeinen Format Bezeichner zu ersetzen.The most common approach is to replace a null format string with the general format specifier.

-Code zum Behandeln von Format Zeichenfolgen, die von der Implementierung unterstützt werden.- Code to handle any format strings that your implementation supports.

-Code zum Behandeln von Format Zeichenfolgen, die Sie nicht unterstützen.- Code to handle format strings that you do not support. Der gängigste Ansatz besteht darin, eine FormatExceptionauszulösen, obwohl Sie die Standard Formatierung bereitstellen können.The most common approach is to throw a FormatException, although you can provide default formatting.

Erweiterungs Implementierungen sind Implementierungen, die eine benutzerdefinierte Formatierung für einen Typ bereitstellen, der bereits Formatierungs Unterstützung unterstützt.Extension implementations are implementations that provide custom formatting for a type that already has formatting support. Beispielsweise können Sie einen customernumformatter definieren, der einen ganzzahligen Typ mit Bindestrichen zwischen bestimmten Ziffern formatiert.For example, you could define a CustomerNumberFormatter that formats an integral type with hyphens between specific digits. In diesem Fall sollte die Implementierung Folgendes umfassen:In this case, your implementation should include the following: : Eine Definition von Format Zeichenfolgen, die die Formatierung des-Objekts erweitern.- A definition of format strings that extend the formatting of the object. Diese Format Zeichenfolgen sind erforderlich, aber Sie dürfen nicht mit den vorhandenen Format Zeichenfolgen des Typs in Konflikt stehen.These format strings are required, but they must not conflict with the type's existing format strings. Wenn Sie z. b. die Formatierung für den Int32 Typ erweitern, sollten Sie nicht die Format Bearbeiter "C", "D", "E", "F" und "G" implementieren.For example, if you are extending formatting for the Int32 type, you should not implement the "C", "D", "E", "F", and "G" format specifiers, among others.

-Ein Test, bei dem der Typ des Objekts, das Format(String, Object, IFormatProvider) an die Methode übermittelt wird, ein Typ ist, dessen Formatierung von der Erweiterung unterstützt- A test that the type of the object passed to your Format(String, Object, IFormatProvider) method is a type whose formatting your extension supports. Wenn dies nicht der Fall ist, müssen Sie IFormattable die-Implementierung des-Objekts, sofern vorhanden, oder die Parameter ToString() lose-Methode des-Objekts, wenn dies nicht der Fall ist, aufzurufen.If it is not, call the object's IFormattable implementation, if one exists, or the object's parameterless ToString() method, if it does not. Sie sollten darauf vorbereitet sein, alle Ausnahmen zu behandeln, die von diesen Methoden aufrufen ausgelöst werden können.You should be prepared to handle any exceptions these method calls might throw.

-Code zum Behandeln von Format Zeichenfolgen, die von der Erweiterung unterstützt werden.- Code to handle any format strings that your extension supports.

-Code zum Behandeln von Format Zeichenfolgen, die von der Erweiterung nicht unterstützt werden.- Code to handle any format strings that your extension does not support. Diese sollten an die IFormattable Implementierung des Typs weitergegeben werden.These should be passed on to the type's IFormattable implementation. Sie sollten darauf vorbereitet sein, alle Ausnahmen zu behandeln, die von diesen Methoden aufrufen ausgelöst werden können.You should be prepared to handle any exceptions these method calls might throw.

Methoden

Format(String, Object, IFormatProvider)

Konvertiert den Wert eines angegebenen Objekts unter Verwendung des angegebenen Formats und der kulturabhängigen Formatierungsinformationen in eine entsprechende Zeichenfolgenentsprechung.Converts the value of a specified object to an equivalent string representation using specified format and culture-specific formatting information.

Gilt für:

Siehe auch