IFormattable.ToString(String, IFormatProvider) メソッド

定義

指定された書式を使用して現在のインスタンスの値を書式設定します。

public:
 System::String ^ ToString(System::String ^ format, IFormatProvider ^ formatProvider);
public string ToString (string format, IFormatProvider formatProvider);
public string ToString (string? format, IFormatProvider? formatProvider);
abstract member ToString : string * IFormatProvider -> string
Public Function ToString (format As String, formatProvider As IFormatProvider) As String

パラメーター

format
String

使用する書式。

  • または - IFormattable 実装の型に対して定義されている既定の形式を使用するには null 参照 (Visual Basic ではNothing)。
formatProvider
IFormatProvider

値の書式設定に使用するプロバイダーです。

  • または - オペレーティング システムの現在のロケール設定から数値形式の情報を取得するための null 参照 (Visual Basic では Nothing)。

戻り値

String

指定された書式の現在のインスタンスの値。

次の例は、 メソッド Temperature を実装するクラスを示 ToString しています。 このコード例は、IFormattable クラスのために提供されている大規模な例の一部です。

using System;
using System.Globalization;

public class Temperature : IFormattable
{
   private decimal temp;

   public Temperature(decimal temperature)
   {
      if (temperature < -273.15m)
        throw new ArgumentOutOfRangeException(String.Format("{0} is less than absolute zero.",
                                              temperature));
      this.temp = temperature;
   }

   public decimal Celsius
   {
      get { return temp; }
   }

   public decimal Fahrenheit
   {
      get { return temp * 9 / 5 + 32; }
   }

   public decimal Kelvin
   {
      get { return temp + 273.15m; }
   }

   public override string ToString()
   {
      return this.ToString("G", CultureInfo.CurrentCulture);
   }

   public string ToString(string format)
   {
      return this.ToString(format, CultureInfo.CurrentCulture);
   }

   public string ToString(string format, IFormatProvider provider)
   {
      if (String.IsNullOrEmpty(format)) format = "G";
      if (provider == null) provider = CultureInfo.CurrentCulture;

      switch (format.ToUpperInvariant())
      {
         case "G":
         case "C":
            return temp.ToString("F2", provider) + " °C";
         case "F":
            return Fahrenheit.ToString("F2", provider) + " °F";
         case "K":
            return Kelvin.ToString("F2", provider) + " K";
         default:
            throw new FormatException(String.Format("The {0} format string is not supported.", format));
      }
   }
}
Imports System.Globalization

Public Class Temperature : Implements IFormattable
   Private temp As Decimal
   
   Public Sub New(temperature As Decimal)
      If temperature < -273.15 Then _ 
        Throw New ArgumentOutOfRangeException(String.Format("{0} is less than absolute zero.", _
                                              temperature))
      Me.temp = temperature
   End Sub
   
   Public ReadOnly Property Celsius As Decimal
      Get
         Return temp
      End Get
   End Property
   
   Public ReadOnly Property Fahrenheit As Decimal
      Get
         Return temp * 9 / 5 + 32
      End Get
   End Property
   
   Public ReadOnly Property Kelvin As Decimal
      Get
         Return temp + 273.15d
      End Get
   End Property

   Public Overrides Function ToString() As String
      Return Me.ToString("G", CultureInfo.CurrentCulture)
   End Function
      
   Public Overloads Function ToString(fmt As String) As String
      Return Me.ToString(fmt, CultureInfo.CurrentCulture)
   End Function
   
   Public Overloads Function ToString(fmt As String, provider As IFormatProvider) _
                   As String _
                   Implements IFormattable.ToString
      If String.IsNullOrEmpty(fmt) Then fmt = "G"
      If provider Is Nothing Then provider = CultureInfo.CurrentCulture
      
      Select Case fmt.ToUpperInvariant()
         Case "G", "C"
            Return temp.ToString("F2", provider) + " °C" 
         Case "F"
            Return Fahrenheit.ToString("F2", provider) + " °F"
         Case "K"
            Return Kelvin.ToString("F2", provider) + " K"
         Case Else
            Throw New FormatException(String.Format("The {0} format string is not supported.", fmt))
      End Select
   End Function
End Class

注釈

メソッド ToString は、値を複数の方法で表現できる文字列形式に変換します。 その正確な形式は、特定のシンボル、または特定の文化、専門職、または業界によって定義された指定された順序に依存します。 メソッドを直接呼び出します。 また、 メソッドと メソッド、および .NET Framework の複合書式設定機能を使用するメソッド (、 など) によって自動的に呼び出 Convert.ToString(Object) Convert.ToString(Object, IFormatProvider) String.Format(String, Object[]) Console.WriteLine(String, Object[]) されます StringBuilder.AppendFormat(String, Object[]) 。 (詳細については、「複合書式設定 」を参照してください)。

複合書式指定メソッドは、書式指定 ToString 文字列内の書式項目ごとにメソッドを 1 回呼び出します。 メソッドに渡されるパラメーターは、次のように、呼び出される特定の書式設定メソッドと書式項目の内容によって異なります。

  • 書式指定項目に書式指定文字列が含されていない場合 (書式項目が単純な場合など)、パラメーターの {0} null 値として渡 System.String されます。

  • 書式指定項目に書式指定文字列 (例: ) が含まれる場合、その書式指定文字列は パラメーターの {0:G} 値として渡 System.String されます。

  • 元のメソッド呼び出しにパラメーターが含されていない場合、 System.IFormatProvider CultureInfo.CurrentCulture は パラメーターの値として渡 System.IFormatProvider されます。

  • 元のメソッド呼び出しにパラメーターが含まれる場合、メソッド呼び出しで指定されたプロバイダーがパラメーター System.IFormatProvider の値として渡 System.IFormatProvider されます。

注意

複合書式指定メソッドが書式プロバイダーを渡していない場合、またはカスタム書式プロバイダーの メソッドが を返す場合にのみ、オブジェクトの実装が ToString ICustomFormatter 呼び Format 出されます null

この.NET Frameworkには、次の 3 つの形式プロバイダーが含まれています。そのすべてが インターフェイスを実装 IFormatProvider します。

  • NumberFormatInfo には、10 進区切り記号とグループ区切り記号に使用する文字、通貨値での通貨記号のスペルと配置などの数値書式情報が提供されます。

  • DateTimeFormatInfo は、日付パターンの月、日、年の位置など、日付関連および時刻関連の書式設定情報を提供します。

  • CultureInfo には、数値形式情報、日付関連および時刻関連の書式設定情報など、特定のカルチャの既定の書式設定情報が含まれている。

さらに、独自のカスタム書式プロバイダーを定義できます。

注意 (実装者)

メソッド ToString(String, IFormatProvider) は、"G" (一般的な) 書式指定子をサポートする必要があります。 クラスでは、"G" 指定子に加え、サポートされる書式指定子のリストを定義できます。 さらに、 クラスは、 である書式指定子を処理するために準備する必要があります null 。 コードの書式設定と書式設定の詳細については、「型の書式設定」 を参照してください

適用対象

こちらもご覧ください