ICustomFormatter Interfejs

Definicja

Definiuje metodę, która obsługuje niestandardowe formatowanie wartości obiektu.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
Atrybuty

Przykłady

Poniższy przykład implementuje ICustomFormatter, aby zezwalać na formatowanie binarne, ósemkowe i szesnastkowe wartości całkowitych.The following example implements ICustomFormatter to allow binary, octal, and hexadecimal formatting of integral values. W tym przykładzie jest to jedna klasa, IBinaryFormatter, implementuje zarówno ICustomFormatter, jak i IFormatProvider.In this example, a single class, IBinaryFormatter, implements both ICustomFormatter and IFormatProvider. Metoda IFormatProvider.GetFormat określa, czy parametr formatType reprezentuje typ ICustomFormatter.Its IFormatProvider.GetFormat method determines whether the formatType parameter represents an ICustomFormatter type. Jeśli tak, BinaryFormatter zwraca wystąpienie samego siebie; w przeciwnym razie zwraca null.If it does, BinaryFormatter returns an instance of itself; otherwise, it returns null. Jej implementacja ICustomFormatter.Format określa, czy parametr formatu jest jednym z trzech obsługiwanych ciągów formatu ("B" dla plików binarnych, "O" dla wartości ósemkowej i "H" w przypadku wartości szesnastkowych) i odpowiednio formatuje parametr arg.Its 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. W przeciwnym razie, jeśli arg nie null, wywoła IFormattable.ToString implementację arg parametru, jeśli taka istnieje, lub jej bezparametrową metodę ToString, jeśli taka nie jest.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. Jeśli arg jest null, metoda zwróci String.Empty.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

BinaryFormatter można następnie użyć do zapewnienia niestandardowego formatowania przez przekazanie obiektu BinaryFormatter jako parametru provider metody Format, jak pokazano w poniższym przykładzie.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)

Uwagi

Interfejs ICustomFormatter zawiera pojedynczą metodę, ICustomFormatter.Format.The ICustomFormatter interface includes a single method, ICustomFormatter.Format. Gdy ten interfejs jest implementowany przez odwołanie lub typ wartości, Metoda Format zwraca reprezentację w postaci ciągu niestandardowego dla obiektu.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.

Zazwyczaj interfejs ICustomFormatter jest implementowany przy użyciu interfejsu IFormatProvider, aby dostosować zachowanie dwóch .NET Framework metod formatowania ciągu złożonego, które zawierają parametr IFormatProvider.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. Interfejs ICustomFormatter może zapewniać niestandardowe formatowanie wartości obiektu przesłanego do metod String.Format(IFormatProvider, String, Object[]) i StringBuilder.AppendFormat(IFormatProvider, String, Object[]).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.

Dostarczenie niestandardowej reprezentacji wartości obiektu wymaga wykonania następujących czynności:Providing a custom representation of an object's value requires that you do the following:

  1. Zdefiniuj klasę, która implementuje interfejs ICustomFormatter i jego pojedynczy element członkowski, Format metodę.Define a class that implements the ICustomFormatter interface and its single member, the Format method.

  2. Zdefiniuj klasę, która implementuje interfejs IFormatProvider i jego pojedynczy element członkowski, GetFormat metodę.Define a class that implements the IFormatProvider interface and its single member, the GetFormat method. Metoda GetFormat zwraca wystąpienie implementacji ICustomFormatter.The GetFormat method returns an instance of your ICustomFormatter implementation. Często jedna klasa implementuje zarówno ICustomFormatter, jak i IFormatProvider.Often, a single class implements both ICustomFormatter and IFormatProvider. W takim przypadku implementacja GetFormat klasy tylko zwraca wystąpienie samego siebie.In that case, the class's GetFormat implementation just returns an instance of itself.

  3. Przekazanie implementacji IFormatProvider jako argumentu provider metody String.Format(IFormatProvider, String, Object[]) lub porównywalnej metody.Pass the IFormatProvider implementation as the provider argument of the String.Format(IFormatProvider, String, Object[]) method or a comparable method.

Metoda .NET Framework będzie używać niestandardowego formatowania zamiast własnych.The .NET Framework method will then use your custom formatting instead of its own.

Uwagi dotyczące implementowania

Środowisko uruchomieniowe języka wspólnego próbuje użyć implementacji ICustomFormatter dla każdego elementu formatu w ciągu formatu złożonego.The common language runtime attempts to use your ICustomFormatter implementation for every format item in a composite format string. W związku z tym należy oczekiwać, że implementacja ICustomFormatter zostanie wywołana w celu zapewnienia usług formatowania dla obiektów lub wartości, które nie są przeznaczone do obsługi.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. W takich przypadkach Metoda Format(String, Object, IFormatProvider) musi wywoływać odpowiednią metodę formatowania dla tego obiektu lub wartości.In these cases, your Format(String, Object, IFormatProvider) method must call the appropriate formatting method for that object or value.

Istnieją dwa rodzaje implementacji ICustomFormatter: wewnętrzne i rozszerzenie.There are two kinds of ICustomFormatter implementations: intrinsic and extension.

Implementacje wewnętrzne to implementacje, które zapewniają niestandardowe formatowanie dla obiektu zdefiniowanego przez aplikację.Intrinsic implementations are implementations that provide custom formatting for an application-defined object. W takim przypadku implementacja powinna obejmować następujące elementy:In this case, your implementation should include the following: -Definicja ciągów formatu, które definiują formatowanie obiektu.- A definition of format strings that define the formatting of the object. Ciągi formatu są opcjonalne.Format strings are optional. Zazwyczaj ciąg formatu "G" lub "g" definiuje ogólny (lub najczęściej używany) format.Typically, a "G" or "g" format string defines the general (or most commonly used) format. Można jednak zdefiniować wszystkie wybrane ciągi formatu.However, you are free to define any format strings that you choose. Możesz również wybrać, czy są rozróżniane wielkości liter, czy nie jest rozróżniana wielkość liter.You are also free to decide whether they are case-sensitive or case-insensitive.

-A test, aby upewnić się, że typ obiektu, który został przesłany do metody Format(String, Object, IFormatProvider) jest typem zdefiniowanym przez aplikację.- A test to ensure that the type of the object passed to your Format(String, Object, IFormatProvider) method is your application-defined type. Jeśli tak nie jest, należy wywołać implementację IFormattable obiektu, jeśli taka istnieje, lub jej metodę ToString(), jeśli nie.If it is not, you should call the object's IFormattable implementation, if one exists, or its ToString() method, if it does not. Należy przygotować się do obsługi wszelkich wyjątków, które mogą zgłosić te wywołania metod.You should be prepared to handle any exceptions these method calls might throw.

-Kod do obsługi ciągu formatu wartości null, jeśli implementacja obsługuje ciągi formatu.- Code to handle a null format string, if your implementation supports format strings. Najbardziej typowym podejściem jest zastąpienie ciągu formatu wartości null przy użyciu specyfikatora formatu ogólnego.The most common approach is to replace a null format string with the general format specifier.

-Kod obsługujący wszystkie ciągi formatu obsługiwane przez implementację.- Code to handle any format strings that your implementation supports.

-Kod obsługujący ciągi formatowania, które nie są obsługiwane.- Code to handle format strings that you do not support. Najbardziej typowym podejściem jest wygenerowanie FormatException, chociaż można podać domyślne formatowanie.The most common approach is to throw a FormatException, although you can provide default formatting.

Implementacje rozszerzeń to implementacje, które zapewniają niestandardowe formatowanie dla typu, który ma już obsługę formatowania.Extension implementations are implementations that provide custom formatting for a type that already has formatting support. Można na przykład zdefiniować CustomerNumberFormatter , który sformatuje typ całkowity z łącznikami między określonymi cyframi.For example, you could define a CustomerNumberFormatter that formats an integral type with hyphens between specific digits. W takim przypadku implementacja powinna obejmować następujące elementy:In this case, your implementation should include the following: -Definicja ciągów formatowania, które poszerzają formatowanie obiektu.- A definition of format strings that extend the formatting of the object. Te ciągi formatu są wymagane, ale nie mogą powodować konfliktu z istniejącymi ciągami formatu typu.These format strings are required, but they must not conflict with the type's existing format strings. Na przykład, jeśli rozszerzasz formatowanie dla typu Int32, nie należy implementować specyfikatorów formatu "C", "D", "E", "F" i "G", między innymi.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.

-Test, że typ obiektu, który został przesłany do metody Format(String, Object, IFormatProvider), jest typem, którego format obsługuje rozszerzenie.- A test that the type of the object passed to your Format(String, Object, IFormatProvider) method is a type whose formatting your extension supports. Jeśli tak nie jest, wywołaj implementację IFormattable obiektu, jeśli taka istnieje, lub bezparametrowego ToString() metody, jeśli nie.If it is not, call the object's IFormattable implementation, if one exists, or the object's parameterless ToString() method, if it does not. Należy przygotować się do obsługi wszelkich wyjątków, które mogą zgłosić te wywołania metod.You should be prepared to handle any exceptions these method calls might throw.

-Kod obsługujący wszystkie ciągi formatu obsługiwane przez rozszerzenie.- Code to handle any format strings that your extension supports.

-Kod obsługujący ciągi formatujące, których rozszerzenie nie obsługuje.- Code to handle any format strings that your extension does not support. Powinny one zostać przesłane do implementacji IFormattable typu.These should be passed on to the type's IFormattable implementation. Należy przygotować się do obsługi wszelkich wyjątków, które mogą zgłosić te wywołania metod.You should be prepared to handle any exceptions these method calls might throw.

Metody

Format(String, Object, IFormatProvider)

Konwertuje wartość określonego obiektu na równoważną reprezentację ciągu przy użyciu określonego formatu i informacji o formatowaniu specyficznym dla kultury.Converts the value of a specified object to an equivalent string representation using specified format and culture-specific formatting information.

Dotyczy

Zobacz też