ICustomFormatter ICustomFormatter ICustomFormatter ICustomFormatter Interface

Definice

Definuje metodu, která podporuje vlastní formátování hodnoty objektu.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
Atributy

Příklady

Následující příklad implementuje ICustomFormatter pro povolení binárního, osmičkového a šestnáctkového formátování integrálních hodnot.The following example implements ICustomFormatter to allow binary, octal, and hexadecimal formatting of integral values. V tomto příkladu jedna třída IBinaryFormatter ICustomFormatter implementuje a IFormatProvider.In this example, a single class, IBinaryFormatter, implements both ICustomFormatter and IFormatProvider. Jeho IFormatProvider.GetFormat metoda určuje formatType , zda parametr představuje ICustomFormatter typ.Its IFormatProvider.GetFormat method determines whether the formatType parameter represents an ICustomFormatter type. Pokud k tomu dojde BinaryFormatter , vrátí instanci sebe sama; v opačném případě nullvrátí.If it does, BinaryFormatter returns an instance of itself; otherwise, it returns null. Jeho ICustomFormatter.Format implementace určuje, zda je parametrem formátu jeden ze tří podporovaných formátovacích řetězců ("B" pro binární, "o" pro osmičkové a "H" pro šestnáctkové ") arg a formátuje parametr odpovídajícím způsobem.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. V opačném arg případě, nullPokud není, volá arg IFormattable.ToString implementaci parametru, pokud existuje, nebo jeho ToString metodu bez parametrů, pokud jedna nikoli.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. Pokud arg String.Emptyje null, metoda vrátí.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

BinaryFormatterlze pak použít k poskytnutí vlastního formátování předáním BinaryFormatter objektu provider jako parametru Format metody, jak ukazuje následující příklad.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)

Poznámky

Rozhraní obsahuje jedinou metodu, ICustomFormatter.Format. ICustomFormatterThe ICustomFormatter interface includes a single method, ICustomFormatter.Format. Pokud je toto rozhraní implementováno pomocí typu odkazu nebo hodnoty, Format vrátí metoda vlastní řetězcovou reprezentaci hodnoty objektu.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.

Rozhraní je obvykle implementováno IFormatProvider s rozhraním pro přizpůsobení chování dvou .NET Framework metod IFormatProvider formátování složených řetězců, které obsahují parametr. ICustomFormatterTypically, 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. Konkrétně rozhraní může poskytovat vlastní formátování hodnoty objektu předané String.Format(IFormatProvider, String, Object[]) metodě a StringBuilder.AppendFormat(IFormatProvider, String, Object[]). ICustomFormatterSpecifically, 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.

Poskytnutí vlastní reprezentace hodnoty objektu vyžaduje, abyste provedete následující kroky:Providing a custom representation of an object's value requires that you do the following:

  1. Definujte třídu, která implementuje ICustomFormatter rozhraní a jeho jediného člena Format , metodu.Define a class that implements the ICustomFormatter interface and its single member, the Format method.

  2. Definujte třídu, která implementuje IFormatProvider rozhraní a jeho jediného člena GetFormat , metodu.Define a class that implements the IFormatProvider interface and its single member, the GetFormat method. Metoda vrátí instanci vaší ICustomFormatter implementace. GetFormatThe GetFormat method returns an instance of your ICustomFormatter implementation. Jedna třída často implementuje i ICustomFormatter. IFormatProviderOften, a single class implements both ICustomFormatter and IFormatProvider. V takovém případě GetFormat implementace třídy pouze vrátí instanci sebe sama.In that case, the class's GetFormat implementation just returns an instance of itself.

  3. IFormatProvider Předat implementaciprovider jako argumentString.Format(IFormatProvider, String, Object[]) metody nebo srovnatelné metody.Pass the IFormatProvider implementation as the provider argument of the String.Format(IFormatProvider, String, Object[]) method or a comparable method.

Metoda .NET Framework pak bude používat vlastní formátování místo vlastní.The .NET Framework method will then use your custom formatting instead of its own.

Poznámky pro implementátory

Modul CLR (Common Language Runtime) se ICustomFormatter pokusí použít vaši implementaci pro každou položku formátu ve složeném formátovacím řetězci.The common language runtime attempts to use your ICustomFormatter implementation for every format item in a composite format string. V důsledku toho byste měli očekávat, že vaše ICustomFormatter implementace bude volána, aby poskytovala služby formátování objektům nebo hodnotám, které nejsou určeny pro zpracování.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. V těchto případech musí vaše Format(String, Object, IFormatProvider) metoda volat odpovídající metodu formátování pro daný objekt nebo hodnotu.In these cases, your Format(String, Object, IFormatProvider) method must call the appropriate formatting method for that object or value.

Existují dva druhy ICustomFormatter implementací: vnitřní a přípona.There are two kinds of ICustomFormatter implementations: intrinsic and extension.

Vnitřní implementace jsou implementace, které poskytují vlastní formátování objektu definovaného aplikací.Intrinsic implementations are implementations that provide custom formatting for an application-defined object. V takovém případě by vaše implementace měla zahrnovat následující:In this case, your implementation should include the following: – Definice formátovacích řetězců, které definují formátování objektu.- A definition of format strings that define the formatting of the object. Řetězce formátu jsou volitelné.Format strings are optional. Obvykle formátový řetězec "G" nebo "g" definuje obecný (nebo nejčastěji používaný) formát.Typically, a "G" or "g" format string defines the general (or most commonly used) format. Můžete však definovat libovolné formátovací řetězce, které zvolíte.However, you are free to define any format strings that you choose. Bez ohledu na velikost písmen nebo velká a malá písmena se také můžete rozhodnout, jestli nerozlišuje velká a malá písmena.You are also free to decide whether they are case-sensitive or case-insensitive.

– Test, který zajistí, že typ objektu předaný do vaší Format(String, Object, IFormatProvider) metody je váš typ definovaný aplikací.- A test to ensure that the type of the object passed to your Format(String, Object, IFormatProvider) method is your application-defined type. Pokud tomu tak není, měli byste zavolat IFormattable implementaci objektu, pokud existuje, nebo jeho ToString() metodu, pokud taková není.If it is not, you should call the object's IFormattable implementation, if one exists, or its ToString() method, if it does not. Měli byste být připraveni zpracovat jakékoli výjimky, které mohou vyvolat volání metody.You should be prepared to handle any exceptions these method calls might throw.

-Code pro zpracování formátovacího řetězce s hodnotou null, pokud vaše implementace podporuje řetězce formátu.- Code to handle a null format string, if your implementation supports format strings. Nejběžnějším přístupem je nahrazení formátovacího řetězce s hodnotou null pomocí obecného specifikátoru formátu.The most common approach is to replace a null format string with the general format specifier.

-Code pro zpracování formátovacích řetězců, které vaše implementace podporuje.- Code to handle any format strings that your implementation supports.

-Code pro zpracování formátovacích řetězců, které nepodporujete.- Code to handle format strings that you do not support. Nejběžnějším přístupem je vyvolat a FormatException, i když můžete zadat výchozí formátování.The most common approach is to throw a FormatException, although you can provide default formatting.

Implementace rozšíření jsou implementace, které poskytují vlastní formátování pro typ, který již podporuje formátování.Extension implementations are implementations that provide custom formatting for a type that already has formatting support. Například můžete definovat CustomerNumberFormatter , který formátuje celočíselný typ pomlčkami mezi konkrétními číslicemi.For example, you could define a CustomerNumberFormatter that formats an integral type with hyphens between specific digits. V takovém případě by vaše implementace měla zahrnovat následující:In this case, your implementation should include the following: – Definice formátovacích řetězců, které rozšířily formátování objektu.- A definition of format strings that extend the formatting of the object. Tyto formátovací řetězce jsou požadovány, ale nesmí být v konfliktu s existujícími formátovacími řetězci typu.These format strings are required, but they must not conflict with the type's existing format strings. Pokud například rozšiřujete formátování pro daný Int32 typ, neměli byste implementovat specifikátory formátu "C", "D", "E", "F" a "G", a to mimo jiné.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, který typ objektu předaný Format(String, Object, IFormatProvider) metodě je typ, jehož formátování podporuje rozšíření.- A test that the type of the object passed to your Format(String, Object, IFormatProvider) method is a type whose formatting your extension supports. Pokud není, zavolejte IFormattable implementaci objektu, pokud existuje, nebo ToString() metodu bez parametrů objektu, pokud tomu tak není.If it is not, call the object's IFormattable implementation, if one exists, or the object's parameterless ToString() method, if it does not. Měli byste být připraveni zpracovat jakékoli výjimky, které mohou vyvolat volání metody.You should be prepared to handle any exceptions these method calls might throw.

-Code pro zpracování formátovacích řetězců, které podporuje vaše rozšíření.- Code to handle any format strings that your extension supports.

-Code pro zpracování formátovacích řetězců, které vaše rozšíření nepodporuje.- Code to handle any format strings that your extension does not support. Ty by měly být předány IFormattable implementaci typu.These should be passed on to the type's IFormattable implementation. Měli byste být připraveni zpracovat jakékoli výjimky, které mohou vyvolat volání metody.You should be prepared to handle any exceptions these method calls might throw.

Metody

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

Převede hodnotu zadaného objektu na odpovídající řetězcovou reprezentaci pomocí zadaného formátu a informací o formátování specifických pro jazykovou verzi.Converts the value of a specified object to an equivalent string representation using specified format and culture-specific formatting information.

Platí pro

Viz také