ICustomFormatter Интерфейс

Определение

Определяет метод, поддерживающий пользовательское форматирование значения объекта.

public interface class ICustomFormatter
public interface ICustomFormatter
[System.Runtime.InteropServices.ComVisible(true)]
public interface ICustomFormatter
type ICustomFormatter = interface
[<System.Runtime.InteropServices.ComVisible(true)>]
type ICustomFormatter = interface
Public Interface ICustomFormatter
Атрибуты

Примеры

В следующем примере реализуется ICustomFormatter , чтобы разрешить двоичное, восьмеричное и шестнадцатеричное форматирование целочисленных значений. В этом примере один класс ( IBinaryFormatter ) реализует ICustomFormatter и IFormatProvider . Его IFormatProvider.GetFormat метод определяет, formatType представляет ли параметр ICustomFormatter тип. Если это так, BinaryFormatter возвращает экземпляр самого себя; в противном случае возвращается значение null . Его ICustomFormatter.Format Реализация определяет, является ли параметр format одной из трех поддерживаемых строк формата ("B" для двоичного, "O" для восьмеричного, а "H" — шестнадцатеричного) и arg соответствующим образом форматирует параметр. В противном случае, если не arg имеет значение, null вызывается arg IFormattable.ToString Реализация параметра, если таковая существует, или его метод без параметров ToString , если он не имеет значение. Если значением параметра arg является null, метод возвращает 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 затем может использоваться для предоставления пользовательского форматирования путем передачи объекта в BinaryFormatter качестве provider параметра Format метода, как показано в следующем примере.

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)

Комментарии

ICustomFormatterИнтерфейс включает один метод, ICustomFormatter.Format . Если этот интерфейс реализуется с помощью ссылки или типа значения, Format метод возвращает строковое представление значения объекта в формате представления.

как правило, ICustomFormatter интерфейс реализуется с помощью IFormatProvider интерфейса для настройки поведения двух платформа .NET Framework методов форматирования составных строк, включающих IFormatProvider параметр. В частности, ICustomFormatter интерфейс может предоставлять пользовательское форматирование значения объекта, передаваемого String.Format(IFormatProvider, String, Object[]) StringBuilder.AppendFormat(IFormatProvider, String, Object[]) методам и.

Для предоставления пользовательского представления значения объекта необходимо выполнить следующие действия.

  1. Определите класс, реализующий ICustomFormatter интерфейс, и его единственный член — Format метод.

  2. Определите класс, реализующий IFormatProvider интерфейс, и его единственный член — GetFormat метод. GetFormatМетод возвращает экземпляр ICustomFormatter реализации. Часто один класс реализует ICustomFormatter и, и IFormatProvider . В этом случае GetFormat Реализация класса просто возвращает экземпляр самого себя.

  3. Передайте IFormatProvider реализацию в качестве provider аргумента String.Format(IFormatProvider, String, Object[]) метода или сопоставимого метода.

затем метод платформа .NET Framework будет использовать пользовательское форматирование вместо собственного.

Примечания для тех, кто реализует этот метод

Среда CLR пытается использовать ICustomFormatter реализацию для каждого элемента форматирования в строке составного формата. В результате следует предполагать, что ICustomFormatter реализация будет вызываться для предоставления служб форматирования объектам или значениям, которые не предназначены для работы. В этих случаях Format(String, Object, IFormatProvider) метод должен вызывать соответствующий метод форматирования для этого объекта или значения.

Существует два вида ICustomFormatter реализаций: встроенная функция и расширение.

Встроенные реализации — это реализации, которые обеспечивают пользовательское форматирование для объекта, определяемого приложением. В этом случае реализация должна включать следующее: — Определение строк формата, определяющих форматирование объекта. Строки формата являются необязательными. Как правило, строка формата G или g определяет общий (или наиболее часто используемый) формат. Тем не менее вы можете определить любые строки формата. Вы также можете решить, учитывается ли регистр или не учитывается регистр.

— Проверка того, что тип объекта, переданного в Format(String, Object, IFormatProvider) метод, является типом, определяемым приложением. Если это не так, следует вызвать IFormattable реализацию объекта, если он существует, или его ToString() метод, если он отсутствует. Вы должны быть готовы обрабатывать любые исключения, которые могут вызываться этими вызовами методов.

— Код для управления строкой формата со значением NULL, если реализация поддерживает строки формата. Наиболее распространенным подходом является замена строки формата null спецификатором общего формата.

— Код для работы с любыми строками формата, поддерживаемых реализацией.

— Код для управления строками формата, которые не поддерживаются. Наиболее распространенным подходом является исключение FormatException , хотя можно предоставить форматирование по умолчанию.

Реализации расширения — это реализации, которые обеспечивают пользовательское форматирование для типа, который уже имеет поддержку форматирования. Например, можно определить кустомернумберформаттер , который форматирует целочисленный тип с дефисами между определенными цифрами. В этом случае реализация должна включать следующее: — Определение строк формата, расширяющих форматирование объекта. Эти строки формата являются обязательными, но они не должны конфликтовать с существующими строками формата типа. Например, если вы расширяете форматирование для Int32 типа, не следует реализовывать описатели формата "C", "D", "E", "F" и "G".

— Проверка того, что тип объекта, переданного в Format(String, Object, IFormatProvider) метод, является типом, форматирование которого поддерживается расширением. Если это не так, вызовите реализацию объекта IFormattable , если таковая существует, или метод без параметров объекта ToString() , если он отсутствует. Вы должны быть готовы обрабатывать любые исключения, которые могут вызываться этими вызовами методов.

— Код для обработки любых строк формата, поддерживаемых расширением.

— Код для обработки любых строк формата, которые не поддерживаются расширением. Они должны передаваться в IFormattable реализацию типа. Вы должны быть готовы обрабатывать любые исключения, которые могут вызываться этими вызовами методов.

Методы

Format(String, Object, IFormatProvider)

Преобразует значение указанного объекта в эквивалентное ему строковое представление с использованием указанного формата и сведений об особенностях форматирования для данного языка и региональных параметров.

Применяется к

См. также раздел