ICustomFormatter インターフェイス

定義

オブジェクトの値のカスタム書式設定をサポートするメソッドを定義します。

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 進数の書式設定を許可します。 この例では、 クラスが 1 つで、 IBinaryFormatter と の両方を ICustomFormatter 実装しています IFormatProvider 。 その IFormatProvider.GetFormat メソッドは、 パラメーターが型 formatType を表すかどうかを決定 ICustomFormatter します。 その場合、 は BinaryFormatter それ自体のインスタンスを返します。それ以外の場合は を返します null 。 その実装では、format パラメーターが 3 つのサポートされる書式指定文字列 (バイナリの場合は "B"、8 進数の場合は "O"、16 進数の場合は ICustomFormatter.Format "H") の 1 つであるかどうかを判断し、パラメーターを適切に書式設定します。 arg それ以外の場合は、 が でない場合は、パラメーターの実装 (存在する場合) またはパラメーターなしメソッド (存在しない場合) arg null arg IFormattable.ToString ToString が呼び出されます。 argnull の場合、メソッドは 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 provider Format 書式設定を提供できます。

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 には、 という 1 つのメソッドが含まれています ICustomFormatter.Format 。 このインターフェイスが参照型または値型によって実装されている場合、メソッドはオブジェクトの値のカスタム形式の文字列表現 Format を返します。

通常、 インターフェイスは、 インターフェイスを使用して実装され、 パラメーターを含む 2 つの複合文字列.NET Frameworkメソッドの動作 ICustomFormatter IFormatProvider をカスタマイズ IFormatProvider します。 具体的には、 インターフェイスは、 メソッドと メソッドに渡されるオブジェクトの値の ICustomFormatter カスタム String.Format(IFormatProvider, String, Object[]) 書式設定を StringBuilder.AppendFormat(IFormatProvider, String, Object[]) 提供できます。

オブジェクトの値のカスタム表現を指定するには、次の操作を行う必要があります。

  1. インターフェイスとその 1 つのメンバー ICustomFormatter である メソッドを実装するクラスを定義 Format します。

  2. インターフェイスとその 1 つのメンバー IFormatProvider である メソッドを実装するクラスを定義 GetFormat します。 メソッド GetFormat は、実装のインスタンスを返 ICustomFormatter します。 多くの場合、1 つのクラスが と の両方を実装 ICustomFormatter します IFormatProvider 。 その場合、クラスの実装は GetFormat それ自体のインスタンスを返すだけになります。

  3. 実装を IFormatProvider メソッドの引数 provider または同等 String.Format(IFormatProvider, String, Object[]) のメソッドとして渡します。

次.NET Frameworkメソッドは、独自の書式設定ではなく、カスタム書式設定を使用します。

注意 (実装者)

共通言語ランタイムは、複合書式指定文字列内のすべての書式 ICustomFormatter 項目に対して実装を使用します。 その結果、処理するように設計されていないオブジェクトまたは値に書式設定サービスを提供するために、実装が呼び ICustomFormatter 出される必要があります。 このような場合、メソッドは、その Format(String, Object, IFormatProvider) オブジェクトまたは値に対して適切な書式設定メソッドを呼び出す必要があります。

実装には、組み込み ICustomFormatter と拡張の 2 種類があります。

組み込み実装は、アプリケーション定義オブジェクトのカスタム書式設定を提供する実装です。 この場合、実装には次のものが含まれる必要があります。

  • オブジェクトの書式設定を定義する書式指定文字列の定義。 書式指定文字列は省略可能です。 通常、"G" または "g" 書式指定文字列は、一般的な (または最も一般的に使用される) 形式を定義します。 ただし、任意の書式指定文字列を自由に定義できます。 また、大文字と小文字を区別するか、大文字と小文字を区別しないかを自由に決定できます。

  • メソッドに渡されるオブジェクトの型がアプリケーション定義型 Format(String, Object, IFormatProvider) であるテスト。 存在しない場合は、オブジェクトの実装 (存在する場合) を呼び出す必要があります。存在しない場合は、そのメソッド IFormattable ToString() を呼び出す必要があります。 これらのメソッド呼び出しがスローする可能性がある例外を処理する準備をする必要があります。

  • 実装で書式指定文字列がサポートされている場合に、null 書式指定文字列を処理するコード。 最も一般的な方法は、null 書式指定文字列を一般的な書式指定子に置き換える方法です。

  • 実装でサポートされている書式指定文字列を処理するコード。

  • サポートされていない書式指定文字列を処理するコード。 最も一般的な方法は、 を FormatException スローする方法ですが、既定の書式設定を指定できます。

拡張機能の実装は、既に書式設定がサポートされている型のカスタム書式設定を提供する実装です。 たとえば、特定の数字の間にハイフンで整数型を書式設定する CustomerNumberFormatter を定義できます。 この場合、実装には次のものが含まれる必要があります。

  • オブジェクトの書式設定を拡張する書式指定文字列の定義。 これらの書式指定文字列は必須ですが、型の既存の書式指定文字列と競合する必要はありません。 たとえば、型の書式設定を拡張する場合は Int32 、"C"、"D"、"E"、"F"、および "G" 書式指定子を実装する必要があります。

  • メソッドに渡されるオブジェクトの型が、拡張機能でサポートされる書式設定 Format(String, Object, IFormatProvider) を持つ型であるテスト。 存在しない場合は、オブジェクトの実装 (存在する場合) またはオブジェクトのパラメーターなしメソッド (存在しない場合) IFormattable ToString() を呼び出します。 これらのメソッド呼び出しがスローする可能性がある例外を処理する準備をする必要があります。

  • 拡張機能でサポートされている書式指定文字列を処理するコード。

  • 拡張機能でサポートされていない書式指定文字列を処理するコード。 これらは、型の実装に渡す必要 IFormattable があります。 これらのメソッド呼び出しがスローする可能性がある例外を処理する準備をする必要があります。

メソッド

Format(String, Object, IFormatProvider)

指定した形式およびカルチャ固有の書式設定情報を使用して、指定したオブジェクトの値をそれと等価の文字列形式に変換します。

適用対象

こちらもご覧ください