ICustomFormatter Interface

Définition

Définit une méthode qui prend en charge la mise en forme personnalisée de la valeur d'un objet.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
Attributs

Exemples

L’exemple suivant implémente ICustomFormatter pour autoriser le formatage binaire, octal et hexadécimal des valeurs intégrales.The following example implements ICustomFormatter to allow binary, octal, and hexadecimal formatting of integral values. Dans cet exemple, une seule classe, IBinaryFormatter, implémente à ICustomFormatter la IFormatProviderfois et.In this example, a single class, IBinaryFormatter, implements both ICustomFormatter and IFormatProvider. Sa IFormatProvider.GetFormat méthode détermine si le formatType paramètre représente un ICustomFormatter type.Its IFormatProvider.GetFormat method determines whether the formatType parameter represents an ICustomFormatter type. Si c’est le BinaryFormatter cas, retourne une instance d’elle-même; nullsinon, elle retourne.If it does, BinaryFormatter returns an instance of itself; otherwise, it returns null. Son ICustomFormatter.Format implémentation détermine si le paramètre de format est l’une des trois chaînes de format prises en charge («B» pour Binary, «O» pour octal et «H» pour hexadécimal) arg et met en forme le paramètre de manière appropriée.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. Sinon, si arg n’est nullpas, il appelle arg l’implémentation IFormattable.ToString du paramètre, le cas échéant, ou sa ToString méthode sans paramètre, si ce n’est pas le cas.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 arg est null, la méthode retourne 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

BinaryFormatterpeut ensuite être utilisé pour fournir une mise en forme personnalisée en BinaryFormatter passant un objet provider comme paramètre de Format la méthode, comme le montre l’exemple suivant.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)

Remarques

L' ICustomFormatter interface comprend une seule méthode, ICustomFormatter.Format.The ICustomFormatter interface includes a single method, ICustomFormatter.Format. Quand cette interface est implémentée par un type référence ou valeur, Format la méthode retourne une représentation sous forme de chaîne personnalisée de la valeur d’un objet.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.

En règle générale ICustomFormatter , l’interface est implémentée avec l' IFormatProvider interface pour personnaliser le comportement de deux .NET Framework méthodes de mise en forme IFormatProvider de chaîne composite qui incluent un paramètre.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. Plus précisément, ICustomFormatter l’interface peut fournir une mise en forme personnalisée de la valeur d’un objet String.Format(IFormatProvider, String, Object[]) passé StringBuilder.AppendFormat(IFormatProvider, String, Object[]) aux méthodes et.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.

Pour fournir une représentation personnalisée de la valeur d’un objet, vous devez effectuer les opérations suivantes:Providing a custom representation of an object's value requires that you do the following:

  1. Définissez une classe qui implémente l' ICustomFormatter interface et son membre unique, la Format méthode.Define a class that implements the ICustomFormatter interface and its single member, the Format method.

  2. Définissez une classe qui implémente l' IFormatProvider interface et son membre unique, la GetFormat méthode.Define a class that implements the IFormatProvider interface and its single member, the GetFormat method. La GetFormat méthode retourne une instance de votre ICustomFormatter implémentation.The GetFormat method returns an instance of your ICustomFormatter implementation. Souvent, une classe unique implémente à ICustomFormatter la IFormatProviderfois et.Often, a single class implements both ICustomFormatter and IFormatProvider. Dans ce cas, l' GetFormat implémentation de la classe retourne simplement une instance d’elle-même.In that case, the class's GetFormat implementation just returns an instance of itself.

  3. Transmettez IFormatProvider l’implémentation provider en tant qu’argument String.Format(IFormatProvider, String, Object[]) de la méthode ou d’une méthode comparable.Pass the IFormatProvider implementation as the provider argument of the String.Format(IFormatProvider, String, Object[]) method or a comparable method.

La méthode .NET Framework utilisera ensuite votre mise en forme personnalisée au lieu de celle qui lui est propre.The .NET Framework method will then use your custom formatting instead of its own.

Notes pour les responsables de l’implémentation

Le Common Language Runtime tente d’utiliser votre ICustomFormatter implémentation pour chaque élément de mise en forme dans une chaîne de format composite.The common language runtime attempts to use your ICustomFormatter implementation for every format item in a composite format string. Par conséquent, vous devez vous attendre à ce ICustomFormatter que votre implémentation soit appelée pour fournir des services de mise en forme aux objets ou aux valeurs qu’elle n’est pas censée gérer.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. Dans ces cas, votre Format(String, Object, IFormatProvider) méthode doit appeler la méthode de mise en forme appropriée pour cet objet ou cette valeur.In these cases, your Format(String, Object, IFormatProvider) method must call the appropriate formatting method for that object or value.

Il existe deux types d' ICustomFormatter implémentations: intrinsèque et extension.There are two kinds of ICustomFormatter implementations: intrinsic and extension.

Les implémentations intrinsèques sont des implémentations qui fournissent une mise en forme personnalisée pour un objet défini par l’application.Intrinsic implementations are implementations that provide custom formatting for an application-defined object. Dans ce cas, votre implémentation doit inclure les éléments suivants:In this case, your implementation should include the following: : Définition des chaînes de format qui définissent la mise en forme de l’objet.- A definition of format strings that define the formatting of the object. Les chaînes de format sont facultatives.Format strings are optional. En règle générale, une chaîne de format "G" ou "g" définit le format général (ou le plus communément utilisé).Typically, a "G" or "g" format string defines the general (or most commonly used) format. Toutefois, vous êtes libre de définir les chaînes de format que vous choisissez.However, you are free to define any format strings that you choose. Vous êtes également libre de décider s’ils respectent la casse ou ne respectent pas la casse.You are also free to decide whether they are case-sensitive or case-insensitive.

-Test pour vérifier que le type de l’objet passé à votre Format(String, Object, IFormatProvider) méthode est votre type défini par l’application.- A test to ensure that the type of the object passed to your Format(String, Object, IFormatProvider) method is your application-defined type. Si ce n’est pas le cas, vous devez appeler IFormattable l’implémentation de l’objet, le cas ToString() échéant, ou sa méthode, si ce n’est pas le cas.If it is not, you should call the object's IFormattable implementation, if one exists, or its ToString() method, if it does not. Vous devez être prêt à gérer toutes les exceptions que ces appels de méthode peuvent lever.You should be prepared to handle any exceptions these method calls might throw.

-Code pour gérer une chaîne de format null, si votre implémentation prend en charge les chaînes de format.- Code to handle a null format string, if your implementation supports format strings. L’approche la plus courante consiste à remplacer une chaîne de format NULL par le spécificateur de format général.The most common approach is to replace a null format string with the general format specifier.

-Code pour gérer toutes les chaînes de format prises en charge par votre implémentation.- Code to handle any format strings that your implementation supports.

-Code pour gérer les chaînes de format que vous ne prenez pas en charge.- Code to handle format strings that you do not support. L’approche la plus courante consiste à lever FormatExceptionune, même si vous pouvez fournir une mise en forme par défaut.The most common approach is to throw a FormatException, although you can provide default formatting.

Les implémentations d’extension sont des implémentations qui fournissent une mise en forme personnalisée pour un type qui prend déjà en charge la mise en forme.Extension implementations are implementations that provide custom formatting for a type that already has formatting support. Par exemple, vous pouvez définir un CustomerNumberFormatter qui met en forme un type intégral avec des traits d’Union entre des chiffres spécifiques.For example, you could define a CustomerNumberFormatter that formats an integral type with hyphens between specific digits. Dans ce cas, votre implémentation doit inclure les éléments suivants:In this case, your implementation should include the following: : Définition des chaînes de format qui étendent la mise en forme de l’objet.- A definition of format strings that extend the formatting of the object. Ces chaînes de format sont obligatoires, mais elles ne doivent pas être en conflit avec les chaînes de format existantes du type.These format strings are required, but they must not conflict with the type's existing format strings. Par exemple, si vous étendez la mise en forme Int32 pour le type, vous ne devez pas implémenter les spécificateurs de format "C", "D", "E", "F" et "G", entre autres.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 que le type de l’objet passé à votre Format(String, Object, IFormatProvider) méthode est un type dont la mise en forme de votre extension prend en charge.- 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 ce n’est pas le cas, appelez IFormattable l’implémentation de l’objet, le cas échéant, ou la ToString() méthode sans paramètre de l’objet, si ce n’est pas le cas.If it is not, call the object's IFormattable implementation, if one exists, or the object's parameterless ToString() method, if it does not. Vous devez être prêt à gérer toutes les exceptions que ces appels de méthode peuvent lever.You should be prepared to handle any exceptions these method calls might throw.

-Code pour gérer les chaînes de format prises en charge par votre extension.- Code to handle any format strings that your extension supports.

-Code pour gérer les chaînes de format que votre extension ne prend pas en charge.- Code to handle any format strings that your extension does not support. Ils doivent être passés à l’implémentation du IFormattable type.These should be passed on to the type's IFormattable implementation. Vous devez être prêt à gérer toutes les exceptions que ces appels de méthode peuvent lever.You should be prepared to handle any exceptions these method calls might throw.

Méthodes

Format(String, Object, IFormatProvider)

Convertit la valeur d'un objet spécifié en une chaîne équivalente à l'aide du format spécifié et des informations de mise en forme propres à la culture.Converts the value of a specified object to an equivalent string representation using specified format and culture-specific formatting information.

S’applique à

Voir aussi