ICustomFormatter Interface

Definição

Define um método que dá suporte à formatação personalizada do valor de um objeto.Defines a method that supports custom formatting of the value of an object.

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

Exemplos

O exemplo a seguir implementa ICustomFormatter para permitir a formatação binária, octal e hexadecimal de valores integrais.The following example implements ICustomFormatter to allow binary, octal, and hexadecimal formatting of integral values. Neste exemplo, uma única classe, IBinaryFormatter, implementa ICustomFormatter e IFormatProvider.In this example, a single class, IBinaryFormatter, implements both ICustomFormatter and IFormatProvider. Seu método IFormatProvider.GetFormat determina se o parâmetro formatType representa um tipo ICustomFormatter.Its IFormatProvider.GetFormat method determines whether the formatType parameter represents an ICustomFormatter type. Se tiver, BinaryFormatter retornará uma instância de si mesmo; caso contrário, ele retornará null.If it does, BinaryFormatter returns an instance of itself; otherwise, it returns null. Sua implementação de ICustomFormatter.Format determina se o parâmetro de formato é uma das três cadeias de caracteres de formato com suporte ("B" para Binary, "O" para octal e "H" para hexadecimal) e formata o parâmetro arg adequadamente.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. Caso contrário, se arg não for null, ele chamará a implementação de IFormattable.ToString do parâmetro de arg, se houver, ou seu método de ToString sem parâmetros, se não houver.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. Se arg for null, o método retornará 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 pode ser usado para fornecer formatação personalizada, passando um objeto BinaryFormatter como o parâmetro provider do método Format, como mostra o exemplo a seguir.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)

Comentários

A interface ICustomFormatter inclui um único método, ICustomFormatter.Format.The ICustomFormatter interface includes a single method, ICustomFormatter.Format. Quando essa interface é implementada por uma referência ou tipo de valor, o método Format retorna uma representação de cadeia de caracteres formatada em formato personalizado do valor de um objeto.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.

Normalmente, a interface ICustomFormatter é implementada com a interface IFormatProvider para personalizar o comportamento de dois métodos de formatação de cadeia de caracteres composta .NET Framework que incluem um parâmetro 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. Especificamente, a interface ICustomFormatter pode fornecer formatação personalizada do valor de um objeto passado para os métodos String.Format(IFormatProvider, String, Object[]) e 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.

Fornecer uma representação personalizada do valor de um objeto requer que você faça o seguinte:Providing a custom representation of an object's value requires that you do the following:

  1. Defina uma classe que implemente a interface ICustomFormatter e seu único membro, o método Format.Define a class that implements the ICustomFormatter interface and its single member, the Format method.

  2. Defina uma classe que implemente a interface IFormatProvider e seu único membro, o método GetFormat.Define a class that implements the IFormatProvider interface and its single member, the GetFormat method. O método GetFormat retorna uma instância de sua implementação de ICustomFormatter.The GetFormat method returns an instance of your ICustomFormatter implementation. Geralmente, uma única classe implementa ICustomFormatter e IFormatProvider.Often, a single class implements both ICustomFormatter and IFormatProvider. Nesse caso, a implementação de GetFormat da classe simplesmente retorna uma instância de si mesma.In that case, the class's GetFormat implementation just returns an instance of itself.

  3. Passe a implementação de IFormatProvider como o argumento provider do método String.Format(IFormatProvider, String, Object[]) ou um método comparável.Pass the IFormatProvider implementation as the provider argument of the String.Format(IFormatProvider, String, Object[]) method or a comparable method.

O método .NET Framework usará sua formatação personalizada em vez de sua própria.The .NET Framework method will then use your custom formatting instead of its own.

Notas aos Implementadores

O Common Language Runtime tenta usar sua implementação de ICustomFormatter para cada item de formato em uma cadeia de caracteres de formato composto.The common language runtime attempts to use your ICustomFormatter implementation for every format item in a composite format string. Como resultado, você deve esperar que sua implementação de ICustomFormatter será chamada para fornecer serviços de formatação a objetos ou valores que ele não tenha sido projetado para lidar.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. Nesses casos, seu método de Format(String, Object, IFormatProvider) deve chamar o método de formatação apropriado para esse objeto ou valor.In these cases, your Format(String, Object, IFormatProvider) method must call the appropriate formatting method for that object or value.

Há dois tipos de implementações de ICustomFormatter: intrínseco e extensão.There are two kinds of ICustomFormatter implementations: intrinsic and extension.

Implementações intrínsecas são implementações que fornecem formatação personalizada para um objeto definido pelo aplicativo.Intrinsic implementations are implementations that provide custom formatting for an application-defined object. Nesse caso, a implementação deve incluir o seguinte:In this case, your implementation should include the following: -Uma definição de cadeias de caracteres de formato que definem a formatação do objeto.- A definition of format strings that define the formatting of the object. Cadeias de caracteres de formato são opcionais.Format strings are optional. Normalmente, uma cadeia de caracteres de formato "G" ou "g" define o formato geral (ou mais comumente usado).Typically, a "G" or "g" format string defines the general (or most commonly used) format. No entanto, você está livre para definir qualquer cadeia de caracteres de formato que escolher.However, you are free to define any format strings that you choose. Você também pode optar por não diferenciar maiúsculas de minúsculas ou não diferenciar maiúsculas de minúsculas.You are also free to decide whether they are case-sensitive or case-insensitive.

-Um teste para garantir que o tipo do objeto passado para seu método de Format(String, Object, IFormatProvider) seja o tipo definido pelo aplicativo.- A test to ensure that the type of the object passed to your Format(String, Object, IFormatProvider) method is your application-defined type. Se não for, você deverá chamar a implementação do IFormattable do objeto, se houver, ou seu método ToString(), se não tiver.If it is not, you should call the object's IFormattable implementation, if one exists, or its ToString() method, if it does not. Você deve estar preparado para lidar com quaisquer exceções que essas chamadas de método possam gerar.You should be prepared to handle any exceptions these method calls might throw.

-Código para manipular uma cadeia de caracteres de formato nulo, se sua implementação der suporte a cadeias de formato.- Code to handle a null format string, if your implementation supports format strings. A abordagem mais comum é substituir uma cadeia de caracteres de formato nulo pelo especificador de formato geral.The most common approach is to replace a null format string with the general format specifier.

-Código para lidar com as cadeias de caracteres de formato às quais sua implementação dá suporte.- Code to handle any format strings that your implementation supports.

-Código para manipular cadeias de caracteres de formato para as quais você não dá suporte.- Code to handle format strings that you do not support. A abordagem mais comum é lançar um FormatException, embora você possa fornecer a formatação padrão.The most common approach is to throw a FormatException, although you can provide default formatting.

Implementações de extensão são implementações que fornecem formatação personalizada para um tipo que já tem suporte para formatação.Extension implementations are implementations that provide custom formatting for a type that already has formatting support. Por exemplo, você pode definir um CustomerNumberFormatter que formata um tipo integral com hifens entre dígitos específicos.For example, you could define a CustomerNumberFormatter that formats an integral type with hyphens between specific digits. Nesse caso, a implementação deve incluir o seguinte:In this case, your implementation should include the following: -Uma definição de cadeias de caracteres de formato que estendem a formatação do objeto.- A definition of format strings that extend the formatting of the object. Essas cadeias de caracteres de formato são necessárias, mas não devem entrar em conflito com as cadeias de caracteres de formato existentes do tipo.These format strings are required, but they must not conflict with the type's existing format strings. Por exemplo, se você estiver estendendo a formatação para o tipo de Int32, não deverá implementar os especificadores de formato "C", "D", "E", "F" e "G", entre outros.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.

-Um teste que o tipo do objeto passado para seu método Format(String, Object, IFormatProvider) é um tipo cuja formatação sua extensão dá suporte.- A test that the type of the object passed to your Format(String, Object, IFormatProvider) method is a type whose formatting your extension supports. Se não estiver, chame a implementação do IFormattable do objeto, se houver, ou o método ToString() sem parâmetros do objeto, se não tiver.If it is not, call the object's IFormattable implementation, if one exists, or the object's parameterless ToString() method, if it does not. Você deve estar preparado para lidar com quaisquer exceções que essas chamadas de método possam gerar.You should be prepared to handle any exceptions these method calls might throw.

-Código para lidar com as cadeias de caracteres de formato às quais sua extensão dá suporte.- Code to handle any format strings that your extension supports.

-Código para lidar com qualquer cadeia de caracteres de formato para a qual sua extensão não dá suporte.- Code to handle any format strings that your extension does not support. Eles devem ser passados para a implementação de IFormattable do tipo.These should be passed on to the type's IFormattable implementation. Você deve estar preparado para lidar com quaisquer exceções que essas chamadas de método possam gerar.You should be prepared to handle any exceptions these method calls might throw.

Métodos

Format(String, Object, IFormatProvider)

Converte o valor de um objeto especificado em uma representação de cadeia de caracteres equivalente usando as informações de formatação específicas da cultura especificada.Converts the value of a specified object to an equivalent string representation using specified format and culture-specific formatting information.

Aplica-se a

Veja também