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 との両方を実装し ICustomFormatterIFormatProvider います。 この IFormatProvider.GetFormat メソッドは、パラメーターが型を表すかどうかを判断し formatType ICustomFormatter ます。 存在する場合は、それ BinaryFormatter 自体のインスタンスを返します。それ以外の場合はを返し null ます。 この ICustomFormatter.Format 実装では、format パラメーターが、サポートされている3つの書式指定文字列 (バイナリの "B"、8進数の "O"、16進数の "H") のいずれかであるかどうかを判断し、パラメーターを適切に書式設定し 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 オブジェクトの値のカスタム書式設定された文字列形式を返します。

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

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

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

  2. インターフェイスを実装するクラス IFormatProvider と、その1つのメンバーであるメソッドを定義 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 既定の書式設定を指定することもできます。

拡張機能の実装は、既に書式設定をサポートしている型のカスタム書式設定を提供する実装です。 たとえば、特定の数字の間にハイフンを使用して整数型を書式設定する、 顧客番号のフォーマッタ を定義できます。 この場合、実装には次のものが含まれている必要があります。 -オブジェクトの書式設定を拡張する書式指定文字列の定義。 これらの書式指定文字列は必須ですが、型の既存の書式指定文字列と競合しないようにする必要があります。 たとえば、型の書式を拡張する場合は、 Int32 "C"、"D"、"E"、"F"、"G" の各書式指定子を実装しないようにする必要があります。

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

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

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

メソッド

Format(String, Object, IFormatProvider)

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

適用対象

こちらもご覧ください