ICustomFormatter ICustomFormatter ICustomFormatter ICustomFormatter Interface

Определение

Определяет метод, поддерживающий нестандартное форматирование значения объекта.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
Атрибуты

Примеры

В следующем примере реализуется ICustomFormatter , чтобы разрешить двоичное, восьмеричное и шестнадцатеричное форматирование целочисленных значений.The following example implements ICustomFormatter to allow binary, octal, and hexadecimal formatting of integral values. В этом примере один класс IBinaryFormatter() ICustomFormatter реализует и IFormatProvider.In this example, a single class, IBinaryFormatter, implements both ICustomFormatter and IFormatProvider. Его IFormatProvider.GetFormat метод определяет, formatType представляет ICustomFormatter ли параметр тип.Its IFormatProvider.GetFormat method determines whether the formatType parameter represents an ICustomFormatter type. Если это так, BinaryFormatter возвращает экземпляр самого себя; в противном nullслучае возвращается значение.If it does, BinaryFormatter returns an instance of itself; otherwise, it returns null. Его ICustomFormatter.Format реализация определяет, является ли параметр format одной из трех поддерживаемых строк формата ("B" для двоичного, "O" для восьмеричного, а "H" — шестнадцатеричного) и arg соответствующим образом форматирует параметр.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. В противном arg случае, nullесли не имеет значение arg , вызывается IFormattable.ToString реализация параметра, если таковая существует, или ToString его метод без параметров, если он не имеет значение.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. Если значением параметра arg является null, метод возвращает 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затем может использоваться для предоставления пользовательского форматирования путем передачи BinaryFormatter объекта в provider качестве параметра Format метода, как показано в следующем примере.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)

Комментарии

Интерфейс включает один метод, ICustomFormatter.Format. ICustomFormatterThe ICustomFormatter interface includes a single method, ICustomFormatter.Format. Если этот интерфейс реализуется с помощью ссылки или типа значения, Format метод возвращает строковое представление значения объекта в формате представления.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.

Как правило, ICustomFormatter интерфейс реализуется IFormatProvider с помощью интерфейса для настройки поведения двух .NET Framework методов 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. В ICustomFormatter частности, интерфейс может предоставлять пользовательское форматирование значения объекта, передаваемого String.Format(IFormatProvider, String, Object[]) методам и 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.

Для предоставления пользовательского представления значения объекта необходимо выполнить следующие действия.Providing a custom representation of an object's value requires that you do the following:

  1. Определите класс, реализующий ICustomFormatter интерфейс, и его единственный член Format — метод.Define a class that implements the ICustomFormatter interface and its single member, the Format method.

  2. Определите класс, реализующий IFormatProvider интерфейс, и его единственный член GetFormat — метод.Define a class that implements the IFormatProvider interface and its single member, the GetFormat method. Метод возвращает экземпляр ICustomFormatterреализации. GetFormatThe GetFormat method returns an instance of your ICustomFormatter implementation. Часто один класс реализует ICustomFormatter и, и. IFormatProviderOften, a single class implements both ICustomFormatter and IFormatProvider. В этом случае GetFormat реализация класса просто возвращает экземпляр самого себя.In that case, the class's GetFormat implementation just returns an instance of itself.

  3. Передайте provider String.Format(IFormatProvider, String, Object[]) реализацию в качестве аргумента метода или сопоставимого метода. IFormatProviderPass the IFormatProvider implementation as the provider argument of the String.Format(IFormatProvider, String, Object[]) method or a comparable method.

Затем метод .NET Framework будет использовать пользовательское форматирование вместо собственного.The .NET Framework method will then use your custom formatting instead of its own.

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

Среда CLR пытается использовать ICustomFormatter реализацию для каждого элемента форматирования в строке составного формата.The common language runtime attempts to use your ICustomFormatter implementation for every format item in a composite format string. В результате следует предполагать, что ICustomFormatter реализация будет вызываться для предоставления служб форматирования объектам или значениям, которые не предназначены для работы.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. В этих случаях Format(String, Object, IFormatProvider) метод должен вызывать соответствующий метод форматирования для этого объекта или значения.In these cases, your Format(String, Object, IFormatProvider) method must call the appropriate formatting method for that object or value.

Существует два вида ICustomFormatter реализаций: встроенная функция и расширение.There are two kinds of ICustomFormatter implementations: intrinsic and extension.

Встроенные реализации — это реализации, которые обеспечивают пользовательское форматирование для объекта, определяемого приложением.Intrinsic implementations are implementations that provide custom formatting for an application-defined object. В этом случае реализация должна включать следующее:In this case, your implementation should include the following: — Определение строк формата, определяющих форматирование объекта.- A definition of format strings that define the formatting of the object. Строки формата являются необязательными.Format strings are optional. Как правило, строка формата G или g определяет общий (или наиболее часто используемый) формат.Typically, a "G" or "g" format string defines the general (or most commonly used) format. Тем не менее вы можете определить любые строки формата.However, you are free to define any format strings that you choose. Вы также можете решить, учитывается ли регистр или не учитывается регистр.You are also free to decide whether they are case-sensitive or case-insensitive.

— Проверка того, что тип объекта, переданного в Format(String, Object, IFormatProvider) метод, является типом, определяемым приложением.- A test to ensure that the type of the object passed to your Format(String, Object, IFormatProvider) method is your application-defined type. Если это не так, следует вызвать IFormattable реализацию объекта, если он существует, или его ToString() метод, если он отсутствует.If it is not, you should call the object's IFormattable implementation, if one exists, or its ToString() method, if it does not. Вы должны быть готовы обрабатывать любые исключения, которые могут вызываться этими вызовами методов.You should be prepared to handle any exceptions these method calls might throw.

— Код для управления строкой формата со значением NULL, если реализация поддерживает строки формата.- Code to handle a null format string, if your implementation supports format strings. Наиболее распространенным подходом является замена строки формата null спецификатором общего формата.The most common approach is to replace a null format string with the general format specifier.

— Код для работы с любыми строками формата, поддерживаемых реализацией.- Code to handle any format strings that your implementation supports.

— Код для управления строками формата, которые не поддерживаются.- Code to handle format strings that you do not support. Наиболее распространенным подходом является исключение FormatException, хотя можно предоставить форматирование по умолчанию.The most common approach is to throw a FormatException, although you can provide default formatting.

Реализации расширения — это реализации, которые обеспечивают пользовательское форматирование для типа, который уже имеет поддержку форматирования.Extension implementations are implementations that provide custom formatting for a type that already has formatting support. Например, можно определить кустомернумберформаттер , который форматирует целочисленный тип с дефисами между определенными цифрами.For example, you could define a CustomerNumberFormatter that formats an integral type with hyphens between specific digits. В этом случае реализация должна включать следующее:In this case, your implementation should include the following: — Определение строк формата, расширяющих форматирование объекта.- A definition of format strings that extend the formatting of the object. Эти строки формата являются обязательными, но они не должны конфликтовать с существующими строками формата типа.These format strings are required, but they must not conflict with the type's existing format strings. Например, если вы расширяете форматирование для Int32 типа, не следует реализовывать описатели формата "C", "D", "E", "F" и "G".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.

— Проверка того, что тип объекта, переданного в Format(String, Object, IFormatProvider) метод, является типом, форматирование которого поддерживается расширением.- A test that the type of the object passed to your Format(String, Object, IFormatProvider) method is a type whose formatting your extension supports. Если это не так, вызовите IFormattable реализацию объекта, если таковая существует, или ToString() метод без параметров объекта, если он отсутствует.If it is not, call the object's IFormattable implementation, if one exists, or the object's parameterless ToString() method, if it does not. Вы должны быть готовы обрабатывать любые исключения, которые могут вызываться этими вызовами методов.You should be prepared to handle any exceptions these method calls might throw.

— Код для обработки любых строк формата, поддерживаемых расширением.- Code to handle any format strings that your extension supports.

— Код для обработки любых строк формата, которые не поддерживаются расширением.- Code to handle any format strings that your extension does not support. Они должны передаваться в IFormattable реализацию типа.These should be passed on to the type's IFormattable implementation. Вы должны быть готовы обрабатывать любые исключения, которые могут вызываться этими вызовами методов.You should be prepared to handle any exceptions these method calls might throw.

Методы

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

Преобразует значение указанного объекта в эквивалентное ему строковое представление, используя указанный формат и сведений об особенностях форматирования, связанных с языком и региональными параметрами.Converts the value of a specified object to an equivalent string representation using specified format and culture-specific formatting information.

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

Дополнительно