ICustomFormatter インターフェイス

定義

オブジェクト値のカスタム書式設定をサポートするメソッドを定義します。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は、を実装して、整数値のバイナリ、8進数、および16進数の書式設定を許可しています。The following example implements ICustomFormatter to allow binary, octal, and hexadecimal formatting of integral values. この例では、1つのIBinaryFormatterクラスがとICustomFormatterIFormatProvider両方を実装しています。In this example, a single class, IBinaryFormatter, implements both ICustomFormatter and IFormatProvider. このメソッドは、パラメーター formatTypeICustomFormatter型を表すかどうかを判断します。 IFormatProvider.GetFormatIts 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. この実装では、format パラメーターが、サポートされている3つの書式指定文字列 (バイナリの "B"、8進数の "O"、16進数の " arg H") のいずれかであるかどうかを判断し、パラメーターを適切に書式設定します。 ICustomFormatter.FormatIts 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次の例に示すように、を使用しBinaryFormatterて、 Formatメソッドproviderのパラメーターとしてオブジェクトを渡すことにより、カスタム書式設定を提供できます。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という1つのメソッドが含まれています。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パラメーターを含む2つのIFormatProvider .NET Framework の複合文字列書式指定メソッドの動作をカスタマイズするには、インターフェイスを使用してインターフェイスを実装します。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インターフェイスを実装するクラスと、その1つのメンバー Formatであるメソッドを定義します。Define a class that implements the ICustomFormatter interface and its single member, the Format method.

  2. IFormatProviderインターフェイスを実装するクラスと、その1つのメンバー 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. 多くの場合、1つの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 メソッドString.Format(IFormatProvider, String, Object[])provider引数として、または比較可能なメソッドとして渡します。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と拡張の2種類があります。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)

指定した書式およびカルチャ固有の書式情報を使用して、指定したオブジェクトの値をそれと等価な文字列形式に変換します。Converts the value of a specified object to an equivalent string representation using specified format and culture-specific formatting information.

適用対象

こちらもご覧ください