ICustomFormatter.Format(String, Object, IFormatProvider) Method

Definition

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

public:
 System::String ^ Format(System::String ^ format, System::Object ^ arg, IFormatProvider ^ formatProvider);
public string Format (string format, object arg, IFormatProvider formatProvider);
abstract member Format : string * obj * IFormatProvider -> string
Public Function Format (format As String, arg As Object, formatProvider As IFormatProvider) As String

Parameters

format
String

서식 사양을 포함하는 형식 문자열입니다.A format string containing formatting specifications.

arg
Object

서식을 지정할 개체입니다.An object to format.

formatProvider
IFormatProvider

현재 인스턴스에 대한 형식 정보를 제공하는 개체입니다.An object that supplies format information about the current instance.

Returns

String

argformat에서 지정한 대로 형식이 지정된 formatProvider 값을 문자열로 나타낸 것입니다.The string representation of the value of arg, formatted as specified by format and formatProvider.

Examples

다음 예제에서는 정수 값의 이진, 8 진수 및 16 진수 형식을 허용 하는 ICustomFormatter을 구현 합니다.The following example implements ICustomFormatter to allow binary, octal, and hexadecimal formatting of integral values. 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

다음 예제와 같이 BinaryFormatter 개체를 Format 메서드의 provider 매개 변수로 전달 하 여 사용자 지정 서식을 제공 하는 데 BinaryFormatter를 사용할 수 있습니다.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)

Remarks

ICustomFormatter.Format 은 콜백 메서드입니다.ICustomFormatter.Format is a callback method. String.Format(IFormatProvider, String, Object[]) 또는 StringBuilder.AppendFormat(IFormatProvider, String, Object[])와 같은 사용자 지정 형식 지정을 지 원하는 메서드에서 호출 됩니다.It is called by a method that supports custom formatting, such as String.Format(IFormatProvider, String, Object[]) or StringBuilder.AppendFormat(IFormatProvider, String, Object[]). 구현은 복합 형식 문자열의 각 형식 항목에 대해 한 번씩 호출 됩니다.The implementation is called once for each format item in a composite format string. 예를 들어 다음 문에서는 ICustomFormatter.Format 메서드가 세 번 호출 됩니다.For example, in the following statement, the ICustomFormatter.Format method is called three times.

Console.WriteLine(String.Format(new BinaryFormatter(),
                                "{0} (binary: {0:B}) (hex: {0:H})", byteValue));
Console.WriteLine(String.Format(New BinaryFormatter(), _
                                "{0} (binary: {0:B}) (hex: {0:H})", byteValue))

arg 매개 변수는 0부터 시작 하는 위치가 특정 형식 항목의 인덱스에 해당 하는 개체 목록의 개체입니다.The arg parameter is the object in the object list whose zero-based position corresponds to the index of a particular format item.

format 매개 변수에는 서식 항목의 formatString 구성 요소인 서식 문자열이 포함 되어 있습니다.The format parameter contains a format string, which is the formatString component of a format item. 형식 항목에 formatString 구성 요소가 없는 경우 format의 값이 null됩니다.If the format item has no formatString component, the value of format is null. format null``arg유형에 따라 사용자가 선택한 기본 형식 지정을 사용할 수 있습니다.If format is null, depending on the type of arg, you may be able to use the default format specification of your choice.

formatProvider 매개 변수는 arg서식 지정을 제공 하는 IFormatProvider 구현입니다.The formatProvider parameter is the IFormatProvider implementation that provides formatting for arg. 일반적으로 ICustomFormatter 구현의 인스턴스입니다.Typically, it is an instance of your ICustomFormatter implementation. formatProvider null이면 해당 매개 변수를 무시 합니다.If formatProvider is null, ignore that parameter.

.NET Framework에서 지원 하지 않는 형식을 제공할 수 있도록 Format 메서드의 구현에는 다음 기능이 포함 되어 있어야 합니다.Your implementation of the Format method must include the following functionality so the .NET Framework can provide formatting you do not support. Format 메서드가 형식을 지원 하지 않는 경우 형식이 지정 되는 개체가 IFormattable 인터페이스를 구현 하는지 여부를 확인 합니다.If your format method does not support a format, determine whether the object being formatted implements the IFormattable interface. 이 경우 해당 인터페이스의 IFormattable.ToString 메서드를 호출 합니다.If it does, invoke the IFormattable.ToString method of that interface. 그렇지 않으면 기본 개체의 기본 Object.ToString 메서드를 호출 합니다.Otherwise, invoke the default Object.ToString method of the underlying object. 다음 코드에서는이 패턴을 보여 줍니다.The following code illustrates this pattern.

if (arg is IFormattable)
   return ((IFormattable)arg).ToString(format, CultureInfo.CurrentCulture);
else if (arg != null)
   return arg.ToString();
If TypeOf arg Is IFormattable Then
   Return DirectCast(arg, IFormattable).ToString(fmt, CultureInfo.CurrentCulture)
ElseIf arg IsNot Nothing Then
   Return arg.ToString()

Applies to

See also