ICustomFormatter ICustomFormatter ICustomFormatter ICustomFormatter Interface

Definición

Define un método que admite formatos personalizados del valor de un objeto.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
Atributos

Ejemplos

ICustomFormatter En el ejemplo siguiente se implementa para permitir el formato binario, octal y hexadecimal de los valores enteros.The following example implements ICustomFormatter to allow binary, octal, and hexadecimal formatting of integral values. En este ejemplo, una sola clase, IBinaryFormatter, implementa ICustomFormatter y IFormatProvider.In this example, a single class, IBinaryFormatter, implements both ICustomFormatter and IFormatProvider. Su IFormatProvider.GetFormat método determina si el formatType parámetro representa un ICustomFormatter tipo.Its IFormatProvider.GetFormat method determines whether the formatType parameter represents an ICustomFormatter type. Si lo hace, BinaryFormatter devuelve una instancia de sí misma; de lo contrario null, devuelve.If it does, BinaryFormatter returns an instance of itself; otherwise, it returns null. Su ICustomFormatter.Format implementación determina si el parámetro de formato es una de las tres cadenas de formato admitidas ("B" para binario, "O" para octal y "H" para hexadecimal) arg y da formato al parámetro de manera adecuada.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. De lo contrario arg , si nullno es, llama arg a la IFormattable.ToString implementación del parámetro, si existe, o a su ToString método sin parámetros, si no hay ninguno.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. Si el valor de arg es null, el método devuelve 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

BinaryFormatterse puede usar para proporcionar un formato personalizado pasando un BinaryFormatter objeto provider como parámetro del Format método, como se muestra en el ejemplo siguiente.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)

Comentarios

La ICustomFormatter interfaz incluye un método único, ICustomFormatter.Format.The ICustomFormatter interface includes a single method, ICustomFormatter.Format. Cuando esta interfaz se implementa mediante una referencia o un tipo de valor Format , el método devuelve una representación de cadena con formato personalizado del valor de un 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, la ICustomFormatter interfaz se implementa con la IFormatProvider interfaz para personalizar el comportamiento de dos .NET Framework métodos de formato de cadena compuesto que IFormatProvider incluyen un parámetro.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. En concreto, ICustomFormatter la interfaz puede proporcionar un formato personalizado del valor de un objeto que se String.Format(IFormatProvider, String, Object[]) pasa StringBuilder.AppendFormat(IFormatProvider, String, Object[]) a los métodos y.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.

Para proporcionar una representación personalizada del valor de un objeto, es necesario hacer lo siguiente:Providing a custom representation of an object's value requires that you do the following:

  1. Defina una clase que implemente la ICustomFormatter interfaz y su miembro único, el Format método.Define a class that implements the ICustomFormatter interface and its single member, the Format method.

  2. Defina una clase que implemente la IFormatProvider interfaz y su miembro único, el GetFormat método.Define a class that implements the IFormatProvider interface and its single member, the GetFormat method. El GetFormat método devuelve una instancia de la ICustomFormatter implementación.The GetFormat method returns an instance of your ICustomFormatter implementation. A menudo, una sola clase implementa ICustomFormatter y. IFormatProviderOften, a single class implements both ICustomFormatter and IFormatProvider. En ese caso, la implementación de GetFormat la clase simplemente devuelve una instancia de sí mismo.In that case, the class's GetFormat implementation just returns an instance of itself.

  3. Pase la IFormatProvider implementación provider como argumento del String.Format(IFormatProvider, String, Object[]) método o un método comparable.Pass the IFormatProvider implementation as the provider argument of the String.Format(IFormatProvider, String, Object[]) method or a comparable method.

A continuación, el método .NET Framework usará el formato personalizado en lugar de su propio.The .NET Framework method will then use your custom formatting instead of its own.

Notas a los implementadores

El Common Language Runtime intenta usar su ICustomFormatter implementación para cada elemento de formato en una cadena de formato compuesto.The common language runtime attempts to use your ICustomFormatter implementation for every format item in a composite format string. Como resultado, debe esperar que se llame a ICustomFormatter la implementación de para proporcionar servicios de formato a los objetos o valores que no está diseñado para controlar.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. En estos casos, el Format(String, Object, IFormatProvider) método debe llamar al método de formato adecuado para ese objeto o valor.In these cases, your Format(String, Object, IFormatProvider) method must call the appropriate formatting method for that object or value.

Hay dos tipos de ICustomFormatter implementaciones: intrínseco y Extension.There are two kinds of ICustomFormatter implementations: intrinsic and extension.

Las implementaciones intrínsecas son implementaciones que proporcionan un formato personalizado para un objeto definido por la aplicación.Intrinsic implementations are implementations that provide custom formatting for an application-defined object. En este caso, la implementación debe incluir lo siguiente:In this case, your implementation should include the following: : Una definición de cadenas de formato que definen el formato del objeto.- A definition of format strings that define the formatting of the object. Las cadenas de formato son opcionales.Format strings are optional. Normalmente, una cadena de formato "G" o "g" define el formato general (o usado con más frecuencia).Typically, a "G" or "g" format string defines the general (or most commonly used) format. Sin embargo, es libre de definir cualquier cadena de formato que elija.However, you are free to define any format strings that you choose. También puede decidir si distinguen mayúsculas de minúsculas o no.You are also free to decide whether they are case-sensitive or case-insensitive.

-Una prueba para asegurarse de que el tipo del objeto pasado al Format(String, Object, IFormatProvider) método es el tipo definido por la aplicación.- A test to ensure that the type of the object passed to your Format(String, Object, IFormatProvider) method is your application-defined type. Si no es así, debe llamar a la implementación del IFormattable objeto, si existe, o su ToString() método, si no lo está.If it is not, you should call the object's IFormattable implementation, if one exists, or its ToString() method, if it does not. Debe estar preparado para controlar las excepciones que pueden producir estas llamadas a métodos.You should be prepared to handle any exceptions these method calls might throw.

-Code para controlar una cadena de formato null, si la implementación admite cadenas de formato.- Code to handle a null format string, if your implementation supports format strings. El enfoque más común consiste en reemplazar una cadena de formato null con el especificador de formato general.The most common approach is to replace a null format string with the general format specifier.

-Code para controlar las cadenas de formato que admite la implementación.- Code to handle any format strings that your implementation supports.

-Code para controlar las cadenas de formato que no admite.- Code to handle format strings that you do not support. El enfoque más común consiste en iniciar una FormatException, aunque puede proporcionar el formato predeterminado.The most common approach is to throw a FormatException, although you can provide default formatting.

Las implementaciones de extensión son implementaciones que proporcionan un formato personalizado para un tipo que ya tiene compatibilidad con el formato.Extension implementations are implementations that provide custom formatting for a type that already has formatting support. Por ejemplo, podría definir un CustomerNumberFormatter que dé formato a un tipo entero con guiones entre dígitos específicos.For example, you could define a CustomerNumberFormatter that formats an integral type with hyphens between specific digits. En este caso, la implementación debe incluir lo siguiente:In this case, your implementation should include the following: : Una definición de cadenas de formato que amplían el formato del objeto.- A definition of format strings that extend the formatting of the object. Estas cadenas de formato son necesarias, pero no deben entrar en conflicto con las cadenas de formato existentes del tipo.These format strings are required, but they must not conflict with the type's existing format strings. Por ejemplo, si va a extender el formato para Int32 el tipo, no debe implementar los especificadores de formato "C", "D", "E", "F" y "G", entre otros.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.

: Una prueba de que el tipo del objeto pasado al Format(String, Object, IFormatProvider) método es un tipo cuyo formato admite la extensión.- A test that the type of the object passed to your Format(String, Object, IFormatProvider) method is a type whose formatting your extension supports. Si no es así, llame a la implementación IFormattable del objeto, si existe, o al ToString() método sin parámetros del objeto, en caso contrario.If it is not, call the object's IFormattable implementation, if one exists, or the object's parameterless ToString() method, if it does not. Debe estar preparado para controlar las excepciones que pueden producir estas llamadas a métodos.You should be prepared to handle any exceptions these method calls might throw.

-Code para controlar cualquier cadena de formato que admita la extensión.- Code to handle any format strings that your extension supports.

-Code para controlar cualquier cadena de formato que no admita la extensión.- Code to handle any format strings that your extension does not support. Se deben pasar a la implementación del IFormattable tipo.These should be passed on to the type's IFormattable implementation. Debe estar preparado para controlar las excepciones que pueden producir estas llamadas a métodos.You should be prepared to handle any exceptions these method calls might throw.

Métodos

Format(String, Object, IFormatProvider) Format(String, Object, IFormatProvider) Format(String, Object, IFormatProvider) Format(String, Object, IFormatProvider)

Convierte el valor de un objeto especificado en una representación en forma de cadena equivalente, utilizando el formato especificado y la información de formato específica de la referencia cultural.Converts the value of a specified object to an equivalent string representation using specified format and culture-specific formatting information.

Se aplica a

Consulte también: