ICustomFormatter 인터페이스

정의

개체 값의 사용자 지정 서식 지정을 지원하는 메서드를 정의합니다.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
[<System.Runtime.InteropServices.ComVisible(true)>]
type ICustomFormatter = interface
Public Interface ICustomFormatter
특성

예제

다음 예제에서는 ICustomFormatter 정수 값의 이진, 8 진수 및 16 진수 형식을 허용 하도록를 구현 합니다.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", 8 진수의 경우 "O" 및 16 진수의 경우 "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. argnull이면 메서드에서 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

BinaryFormatterBinaryFormatter 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 단일 메서드를 포함 하는 인터페이스 ICustomFormatter.Format합니다.The 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. GetFormat메서드는 구현 인스턴스를 반환 합니다 ICustomFormatter .The GetFormat method returns an instance of your ICustomFormatter implementation. 단일 클래스가 및를 둘 다 구현 하는 경우가 많습니다 ICustomFormatter IFormatProvider .Often, a single class implements both ICustomFormatter and IFormatProvider. 이 경우 클래스의 GetFormat 구현은 자체의 인스턴스를 반환 하기만 합니다.In that case, the class's GetFormat implementation just returns an instance of itself.

  3. IFormatProvider구현을 provider String.Format(IFormatProvider, String, Object[]) 메서드 또는 비교 가능한 메서드의 인수로 전달 합니다.Pass 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.

구현자 참고

공용 언어 런타임은 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. 이러한 메서드 호출이 throw 할 수 있는 예외를 처리 하도록 준비 해야 합니다.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. 가장 일반적인 방법은를 throw 하는 것입니다 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. 예를 들어 특정 숫자 사이에 하이픈이 있는 정수 계열 형식의 형식을 지정 하는 Customer번호 포맷터 를 정의할 수 있습니다.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. 이러한 메서드 호출이 throw 할 수 있는 예외를 처리 하도록 준비 해야 합니다.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. 이러한 메서드 호출이 throw 할 수 있는 예외를 처리 하도록 준비 해야 합니다.You should be prepared to handle any exceptions these method calls might throw.

메서드

Format(String, Object, IFormatProvider)

지정된 형식 및 문화권별 형식 지정 정보를 사용하여 지정된 개체의 값을 해당 문자열 표현으로 변환합니다.Converts the value of a specified object to an equivalent string representation using specified format and culture-specific formatting information.

적용 대상

추가 정보