ICustomFormatter ICustomFormatter ICustomFormatter ICustomFormatter Interface

Definizione

Definisce un metodo che supporta la formattazione personalizzata del valore di un oggetto.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
Attributi

Esempi

L'esempio seguente implementa ICustomFormatter per consentire la formattazione binaria, ottali ed esadecimali di valori integrali.The following example implements ICustomFormatter to allow binary, octal, and hexadecimal formatting of integral values. In questo esempio, una sola classe, IBinaryFormatter, implementa entrambe ICustomFormatter e IFormatProvider.In this example, a single class, IBinaryFormatter, implements both ICustomFormatter and IFormatProvider. Relativi IFormatProvider.GetFormat metodo determina se il formatType parametro rappresenta un ICustomFormatter tipo.Its IFormatProvider.GetFormat method determines whether the formatType parameter represents an ICustomFormatter type. In caso affermativo BinaryFormatter restituisce un'istanza di se stesso; in caso contrario, restituisce null.If it does, BinaryFormatter returns an instance of itself; otherwise, it returns null. Relativi ICustomFormatter.Format implementazione determina se il parametro di formato è una delle tre stringhe di formato supportato ("B" binario, "O" per ottale e "H" per esadecimale) e formatta il arg parametro in modo appropriato.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. In caso contrario, se arg non è null, viene chiamato il arg del parametro IFormattable.ToString implementazione, se presente, o relativo senza parametri ToString metodo, se non esiste.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 è null, il metodo restituisce 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 è quindi utilizzabile per fornire formattazione personalizzata mediante il passaggio di un BinaryFormatter dell'oggetto come i provider parametro del Format metodo, come illustrato nell'esempio seguente.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)

Commenti

Il ICustomFormatter interfaccia include un solo metodo, ICustomFormatter.Format.The ICustomFormatter interface includes a single method, ICustomFormatter.Format. Quando questa interfaccia viene implementata da un tipo riferimento o valore, il Format metodo restituisce una rappresentazione di stringa con formattazione personalizzata del valore dell'oggetto.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.

In genere, l'interfaccia ICustomFormatter viene implementata con l'interfaccia IFormatProvider per personalizzare il comportamento di due metodi di formattazione composta di stringhe di .NET Framework che includono un parametro 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. In particolare, l'interfaccia ICustomFormatter è in grado di fornire una formattazione personalizzata del valore di un oggetto passato ai metodi 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.

Fornire una rappresentazione grafica del valore di un oggetto, è necessario procedere nel modo seguente:Providing a custom representation of an object's value requires that you do the following:

  1. Definire una classe che implementa il ICustomFormatter interfaccia e il relativo membro singolo, il Format (metodo).Define a class that implements the ICustomFormatter interface and its single member, the Format method.

  2. Definire una classe che implementa il IFormatProvider interfaccia e il relativo membro singolo, il GetFormat (metodo).Define a class that implements the IFormatProvider interface and its single member, the GetFormat method. Il GetFormat metodo restituisce un'istanza di ICustomFormatter implementazione.The GetFormat method returns an instance of your ICustomFormatter implementation. Spesso, una singola classe implementa entrambe ICustomFormatter e IFormatProvider.Often, a single class implements both ICustomFormatter and IFormatProvider. In del tal caso, la classe GetFormat implementazione restituisce solo un'istanza di se stesso.In that case, the class's GetFormat implementation just returns an instance of itself.

  3. Passare il IFormatProvider implementazione come i provider argomento del String.Format(IFormatProvider, String, Object[]) metodo o un metodo confrontabile.Pass the IFormatProvider implementation as the provider argument of the String.Format(IFormatProvider, String, Object[]) method or a comparable method.

Il metodo di .NET Framework userà la formattazione personalizzata anziché la propria.The .NET Framework method will then use your custom formatting instead of its own.

Note per gli implementatori

Common language runtime tenta di usare il ICustomFormatter implementazione per ogni elemento di formato in una stringa di formato composito.The common language runtime attempts to use your ICustomFormatter implementation for every format item in a composite format string. Di conseguenza, è necessario prevedere che il ICustomFormatter implementazione verrà chiamata per fornire servizi di formattazione per gli oggetti o valori che non consente di gestire.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 questi casi, il Format(String, Object, IFormatProvider) metodo deve chiamare il metodo di formattazione appropriato per tale oggetto o un valore.In these cases, your Format(String, Object, IFormatProvider) method must call the appropriate formatting method for that object or value.

Esistono due tipi di ICustomFormatter implementazioni: funzione intrinseca e l'estensione.There are two kinds of ICustomFormatter implementations: intrinsic and extension.

Le implementazioni di intrinseche sono implementazioni che forniscono formattazione personalizzata per un oggetto definito dall'applicazione.Intrinsic implementations are implementations that provide custom formatting for an application-defined object. In questo caso, l'implementazione deve includere quanto segue:In this case, your implementation should include the following: -Definizione di stringhe di formato che definisce la formattazione dell'oggetto.- A definition of format strings that define the formatting of the object. Le stringhe di formato sono facoltative.Format strings are optional. In genere, una stringa di formato "G" o "g" definisce il formato generale (o più usato).Typically, a "G" or "g" format string defines the general (or most commonly used) format. Tuttavia, si possono definire eventuali stringhe di formato scelto.However, you are free to define any format strings that you choose. Si possono anche decidere se sono tra maiuscole e minuscole o maiuscole e minuscole.You are also free to decide whether they are case-sensitive or case-insensitive.

-Un test per assicurarsi che il tipo dell'oggetto passato per il Format(String, Object, IFormatProvider) metodo rappresentato dal tipo definito dall'applicazione.- A test to ensure that the type of the object passed to your Format(String, Object, IFormatProvider) method is your application-defined type. In caso contrario, è necessario chiamare l'oggetto IFormattable implementazione, se ne esiste uno, o dai relativi ToString() metodo, se non esiste.If it is not, you should call the object's IFormattable implementation, if one exists, or its ToString() method, if it does not. È consigliabile essere preparati a gestire le eccezioni potrebbero generare queste chiamate al metodo.You should be prepared to handle any exceptions these method calls might throw.

-Codice per gestire una stringa di formato null se l'implementazione supporta le stringhe di formato.- Code to handle a null format string, if your implementation supports format strings. L'approccio più comune consiste nel sostituire una stringa di formato null con l'identificatore di formato generale.The most common approach is to replace a null format string with the general format specifier.

-Codice per gestire tutte le stringhe di formato che supporta l'implementazione.- Code to handle any format strings that your implementation supports.

-Codice per gestire le stringhe di formato che non supportata.- Code to handle format strings that you do not support. L'approccio più comune prevede la generazione di un FormatException, sebbene sia possibile fornire la formattazione predefinita.The most common approach is to throw a FormatException, although you can provide default formatting.

Le implementazioni delle estensioni sono implementazioni che forniscono formattazione personalizzata per un tipo che dispone già di supporto per la formattazione.Extension implementations are implementations that provide custom formatting for a type that already has formatting support. Ad esempio, è possibile definire un CustomerNumberFormatter che formatta un tipo integrale con trattini tra le cifre specifici.For example, you could define a CustomerNumberFormatter that formats an integral type with hyphens between specific digits. In questo caso, l'implementazione deve includere quanto segue:In this case, your implementation should include the following: -Definizione di stringhe di formato che estendono la formattazione dell'oggetto.- A definition of format strings that extend the formatting of the object. Queste stringhe di formato sono necessarie, ma non devono essere in conflitto con le stringhe di formato esistente del tipo.These format strings are required, but they must not conflict with the type's existing format strings. Ad esempio, se si vuole estendere formattazione per il Int32 tipo, è consigliabile non implementare gli identificatori di formato "C", "D", "E", "F" e "G", tra gli altri.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.

-Un test che il tipo dell'oggetto passato per il Format(String, Object, IFormatProvider) metodo è un tipo la cui formattazione dell'estensione supporta.- A test that the type of the object passed to your Format(String, Object, IFormatProvider) method is a type whose formatting your extension supports. In caso contrario, chiamare l'oggetto IFormattable implementazione, se ne esiste uno, o senza parametri dell'oggetto ToString() metodo, se non esiste.If it is not, call the object's IFormattable implementation, if one exists, or the object's parameterless ToString() method, if it does not. È consigliabile essere preparati a gestire le eccezioni potrebbero generare queste chiamate al metodo.You should be prepared to handle any exceptions these method calls might throw.

-Codice per gestire eventuali stringhe di formato supportate dall'estensione.- Code to handle any format strings that your extension supports.

-Codice per gestire tutte le stringhe di formato che non supporta l'estensione.- Code to handle any format strings that your extension does not support. Questi devono essere passati nel tipo IFormattable implementazione.These should be passed on to the type's IFormattable implementation. È consigliabile essere preparati a gestire le eccezioni potrebbero generare queste chiamate al metodo.You should be prepared to handle any exceptions these method calls might throw.

Metodi

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

Converte il valore di un oggetto specificato in una rappresentazione in forma di stringa equivalente utilizzando il formato e le informazioni di formattazione specifiche delle impostazioni cultura.Converts the value of a specified object to an equivalent string representation using specified format and culture-specific formatting information.

Si applica a

Vedi anche