ICustomFormatter Arabirim

Tanım

Bir nesnenin değerinin özel biçimlendirmesini destekleyen bir yöntemi tanımlar.Defines a method that supports custom formatting of the value of an object.

public interface class ICustomFormatter
public interface ICustomFormatter
[System.Runtime.InteropServices.ComVisible(true)]
public interface ICustomFormatter
type ICustomFormatter = interface
Public Interface ICustomFormatter
Öznitelikler

Örnekler

Aşağıdaki örnek, tamsayı değerlerinin ikili, sekizlik ve onaltılık biçimlendirmesine izin vermek için ICustomFormatter uygular.The following example implements ICustomFormatter to allow binary, octal, and hexadecimal formatting of integral values. Bu örnekte, tek bir sınıf IBinaryFormatter, hem ICustomFormatter hem de IFormatProvideruygular.In this example, a single class, IBinaryFormatter, implements both ICustomFormatter and IFormatProvider. IFormatProvider.GetFormat yöntemi formatType parametresinin bir ICustomFormatter türünü temsil edip etmediğini belirler.Its IFormatProvider.GetFormat method determines whether the formatType parameter represents an ICustomFormatter type. Varsa, BinaryFormatter kendi örneğini döndürür; Aksi takdirde, nulldöndürür.If it does, BinaryFormatter returns an instance of itself; otherwise, it returns null. ICustomFormatter.Format uygulamasının biçim parametresinin, ikili için desteklenen üç biçim dizesinin ("B", sekizlik için "O" ve onaltılı için "H") biri olup olmadığını belirler ve arg parametresini uygun şekilde biçimlendirir.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. Aksi takdirde, arg nullyoksa, varsa arg parametrenin IFormattable.ToString uygulamasını veya varsa parametresiz ToString yöntemini çağırır.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, yöntemi String.Emptydöndürür.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 daha sonra, aşağıdaki örnekte gösterildiği gibi, bir BinaryFormatter nesnesini Format yönteminin provider parametresi olarak geçirerek özel biçimlendirme sağlamak için kullanılabilir.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)

Açıklamalar

ICustomFormatter arabirimi tek bir yöntemi içerir, ICustomFormatter.Format.The ICustomFormatter interface includes a single method, ICustomFormatter.Format. Bu arabirim bir başvuru veya değer türü tarafından uygulandığında, Format yöntemi bir nesnenin değerinin özel biçimli bir dize gösterimini döndürür.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.

Genellikle ICustomFormatter arabirimi, bir IFormatProvider parametresi içeren iki .NET Framework bileşik dize biçimlendirme yönteminin davranışını özelleştirmek için IFormatProvider arabirimi ile uygulanır.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. Özellikle ICustomFormatter arabirimi, String.Format(IFormatProvider, String, Object[]) ve StringBuilder.AppendFormat(IFormatProvider, String, Object[]) yöntemlerine geçirilen bir nesne değerinin özel biçimlendirmesini sağlayabilir.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.

Bir nesnenin değerinin özel bir gösterimini sağlamak için şunları yapmanız gerekir:Providing a custom representation of an object's value requires that you do the following:

  1. ICustomFormatter arabirimini ve tek üyesini uygulayan, Format yöntemi olan bir sınıf tanımlayın.Define a class that implements the ICustomFormatter interface and its single member, the Format method.

  2. IFormatProvider arabirimini ve tek üyesini uygulayan, GetFormat yöntemi olan bir sınıf tanımlayın.Define a class that implements the IFormatProvider interface and its single member, the GetFormat method. GetFormat yöntemi ICustomFormatter uygulamanızın bir örneğini döndürür.The GetFormat method returns an instance of your ICustomFormatter implementation. Genellikle, tek bir sınıf hem ICustomFormatter hem de IFormatProvideruygular.Often, a single class implements both ICustomFormatter and IFormatProvider. Bu durumda, sınıfın GetFormat uygulamasının yalnızca bir örneğini döndürür.In that case, the class's GetFormat implementation just returns an instance of itself.

  3. IFormatProvider uygulamasını String.Format(IFormatProvider, String, Object[]) yönteminin provider bağımsız değişkeni olarak veya karşılaştırılabilir bir yöntem olarak geçirin.Pass the IFormatProvider implementation as the provider argument of the String.Format(IFormatProvider, String, Object[]) method or a comparable method.

.NET Framework yöntemi, kendi yerine özel biçimlendirmenizi kullanacaktır.The .NET Framework method will then use your custom formatting instead of its own.

Uygulayanlara Notlar

Ortak dil çalışma zamanı, bileşik biçim dizesindeki her biçim öğesi için ICustomFormatter uygulamanızı kullanmayı dener.The common language runtime attempts to use your ICustomFormatter implementation for every format item in a composite format string. Sonuç olarak, ICustomFormatter uygulamanızın, işlemek için tasarlanmamış nesnelere veya değerlere biçimlendirme hizmetleri sağlamak için çağrılabilmesi beklenir.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. Bu durumlarda, Format(String, Object, IFormatProvider) yönteminizin bu nesne veya değer için uygun biçimlendirme yöntemini çağırması gerekir.In these cases, your Format(String, Object, IFormatProvider) method must call the appropriate formatting method for that object or value.

İki tür ICustomFormatter uygulaması vardır: iç ve uzantı.There are two kinds of ICustomFormatter implementations: intrinsic and extension.

İç uygulamalar, uygulama tanımlı bir nesne için özel biçimlendirme sağlayan uygulamalardır.Intrinsic implementations are implementations that provide custom formatting for an application-defined object. Bu durumda, uygulamanız aşağıdakileri içermelidir:In this case, your implementation should include the following: -Nesnenin biçimlendirmesini tanımlayan biçim dizelerinin tanımı.- A definition of format strings that define the formatting of the object. Biçim dizeleri isteğe bağlıdır.Format strings are optional. Genellikle, "G" veya "g" biçim dizesi genel (veya en yaygın olarak kullanılan) biçimi tanımlar.Typically, a "G" or "g" format string defines the general (or most commonly used) format. Ancak, seçtiğiniz herhangi bir biçim dizesini tanımlamanız ücretsizdir.However, you are free to define any format strings that you choose. Ayrıca, büyük/küçük harfe duyarlı veya büyük/küçük harfe duyarlı olup olmadığına karar verebilirsiniz.You are also free to decide whether they are case-sensitive or case-insensitive.

-Format(String, Object, IFormatProvider) metoduna geçirilen nesne türünün uygulama tanımlı türde olduğundan emin olmak için bir test.- A test to ensure that the type of the object passed to your Format(String, Object, IFormatProvider) method is your application-defined type. Aksi takdirde, varsa nesnenin IFormattable uygulamasını, varsa veya ToString() yöntemini çağırmanız gerekir.If it is not, you should call the object's IFormattable implementation, if one exists, or its ToString() method, if it does not. Bu yöntem çağrılarının oluşturmakta olduğu tüm özel durumları işlemeye hazırlanmalısınız.You should be prepared to handle any exceptions these method calls might throw.

-Uygulamanız biçim dizelerini destekliyorsa, null biçim dizesini işlemek için kod.- Code to handle a null format string, if your implementation supports format strings. En yaygın yaklaşım, bir null biçim dizesinin genel biçim belirticisi ile değiştirilmesini kullanmaktır.The most common approach is to replace a null format string with the general format specifier.

-Uygulamanızın desteklediği biçim dizelerini işlemek için kod.- Code to handle any format strings that your implementation supports.

-Desteklenmeyen biçim dizelerini işlemek için kod.- Code to handle format strings that you do not support. En yaygın yaklaşım bir FormatExceptionoluşturmaktır, ancak varsayılan biçimlendirme sağlayabiliriz.The most common approach is to throw a FormatException, although you can provide default formatting.

Uzantı uygulamaları, zaten biçimlendirme desteği olan bir tür için özel biçimlendirme sağlayan uygulamalardır.Extension implementations are implementations that provide custom formatting for a type that already has formatting support. Örneğin, bir tamsayı türünü belirli basamaklar arasında tire ile biçimlendiren bir CustomerNumberFormatter tanımlayabilirsiniz.For example, you could define a CustomerNumberFormatter that formats an integral type with hyphens between specific digits. Bu durumda, uygulamanız aşağıdakileri içermelidir:In this case, your implementation should include the following: -Nesnenin biçimlendirmesini genişleten biçim dizelerinin tanımı.- A definition of format strings that extend the formatting of the object. Bu biçim dizeleri gereklidir, ancak türün varolan biçim dizeleri ile çakışmaması gerekir.These format strings are required, but they must not conflict with the type's existing format strings. Örneğin, Int32 türü için biçimlendirme uzatıyorsanız, diğerleri arasında "C", "D", "E", "F" ve "G" biçim belirticilerini uygulamamalısınız.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) metoduna geçirilen nesne türünün, uzantınızı desteklediği bir tür olduğunu belirten bir test.- A test that the type of the object passed to your Format(String, Object, IFormatProvider) method is a type whose formatting your extension supports. Aksi takdirde, varsa nesnenin IFormattable uygulamasını ya da nesnenin parametresiz ToString() yöntemini çağırın.If it is not, call the object's IFormattable implementation, if one exists, or the object's parameterless ToString() method, if it does not. Bu yöntem çağrılarının oluşturmakta olduğu tüm özel durumları işlemeye hazırlanmalısınız.You should be prepared to handle any exceptions these method calls might throw.

-Uzantınızın desteklediği biçim dizelerini işlemek için kod.- Code to handle any format strings that your extension supports.

-Uzantınızın desteklemediği biçim dizelerini işlemek için kod.- Code to handle any format strings that your extension does not support. Bu, türün IFormattable uygulamasına geçirilmesi gerekir.These should be passed on to the type's IFormattable implementation. Bu yöntem çağrılarının oluşturmakta olduğu tüm özel durumları işlemeye hazırlanmalısınız.You should be prepared to handle any exceptions these method calls might throw.

Yöntemler

Format(String, Object, IFormatProvider)

Belirtilen biçim ve kültüre özgü biçimlendirme bilgilerini kullanarak belirtilen nesnenin değerini eşdeğer dize gösterimine dönüştürür.Converts the value of a specified object to an equivalent string representation using specified format and culture-specific formatting information.

Şunlara uygulanır

Ayrıca bkz.