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

定義

指定された書式を使用して現在のインスタンスの値を書式設定します。Formats the value of the current instance using the specified format.

public:
 System::String ^ ToString(System::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

使用する書式。The format to use.

または-or- Nothing 実装の型に対して定義されている既定の形式を使用するには null 参照 (Visual Basic ではIFormattable)。A null reference (Nothing in Visual Basic) to use the default format defined for the type of the IFormattable implementation.

formatProvider
IFormatProvider

値を書式設定するために使用するプロバイダー。The provider to use to format the value.

または-or- オペレーティング システムの現在のロケール設定から数値形式の情報を取得するための null 参照 (Visual Basic では Nothing)。A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.

戻り値

指定された書式の現在のインスタンスの値。The value of the current instance in the specified format.

次の例は、ToString メソッドを実装する Temperature クラスを示しています。The following example demonstrates a Temperature class that implements the ToString method. このコード例は、IFormattable クラス用に用意されている大規模な例の一部です。This code example is part of a larger example provided for the IFormattable class.

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 メソッドは、値を複数の方法で表現できる文字列形式に変換します。The ToString method converts a value to a string representation that can be expressed in multiple ways. 正確な形式は、特定のカルチャ、職業、または業界によって定義された特定の記号や指定された順序によって異なります。Its precise format depends on specific symbols or a specified order defined by specific cultures, professions, or industries. メソッドは直接呼び出すことができます。You can call the method directly. また、Convert.ToString(Object) および Convert.ToString(Object, IFormatProvider) メソッドによって自動的に呼び出されるほか、.NET Framework の複合書式指定機能 (String.Format(String, Object[])Console.WriteLine(String, Object[])StringBuilder.AppendFormat(String, Object[])など) を使用するメソッドによっても呼び出されます。It is also called automatically by the Convert.ToString(Object) and Convert.ToString(Object, IFormatProvider) methods, and by methods that use the composite formatting feature in the .NET Framework, such as String.Format(String, Object[]), Console.WriteLine(String, Object[]), and StringBuilder.AppendFormat(String, Object[]). (詳細については、「複合書式指定」を参照してください)。(For more information, see Composite Formatting.)

複合書式指定メソッドは、書式指定文字列の書式指定項目ごとに ToString メソッドを1回呼び出します。Composite formatting methods call the ToString method once for each format item in a format string. メソッドに渡されるパラメーターは、次のように、書式指定項目の内容および書式指定項目の内容に対して呼び出される特定の書式指定メソッドによって異なります。The parameters passed to the method depend on the specific formatting method that is called and on the content of the format item, as follows:

  • 書式指定項目に書式文字列が含まれていない場合 (たとえば、書式項目が単に {0})、System.String パラメーターの値として null 渡されます。If the format item does not include a format string (for example, if the format item is simply {0}), it is passed null as the value of the System.String parameter.

  • 書式指定文字列 ({0:G}など) が書式設定項目に含まれている場合は、その書式文字列が System.String パラメーターの値として渡されます。If the format item includes a format string (for example, {0:G}), that format string is passed as the value of the System.String parameter.

  • 元のメソッド呼び出しに System.IFormatProvider パラメーターが含まれていない場合、CultureInfo.CurrentCultureSystem.IFormatProvider パラメーターの値として渡されます。If the original method call does not include an System.IFormatProvider parameter, CultureInfo.CurrentCulture is passed as the value of the System.IFormatProvider parameter.

  • 元のメソッドの呼び出しに System.IFormatProvider パラメーターが含まれている場合、メソッドの呼び出しで指定されたプロバイダーは、System.IFormatProvider パラメーターの値として渡されます。If the original method call includes an System.IFormatProvider parameter, the provider that is supplied in the method call is passed as the value of the System.IFormatProvider parameter.

注意

オブジェクトの ToString 実装は、ICustomFormatter 形式プロバイダーが渡されない場合、またはカスタム書式プロバイダーの Format メソッドが nullを返す場合にのみ、複合書式指定メソッドによって呼び出されます。An object's ToString implementation is called by composite formatting methods only if they are not passed an ICustomFormatter format provider, or if the Format method of the custom format provider returns null.

.NET Framework には、次の3つの書式プロバイダーが含まれています。これらはすべて IFormatProvider インターフェイスを実装します。The .NET Framework includes three format providers, all of which implement the IFormatProvider interface:

  • NumberFormatInfo には、小数点と桁区切り記号に使用する文字、通貨記号のスペルと位置など、数値の書式設定情報を指定します。NumberFormatInfo supplies numeric formatting information, such as the characters to use for decimal and group separators, and the spelling and placement of currency symbols in monetary values.

  • DateTimeFormatInfo は、日付パターンにおける月、日、および年の位置など、日付関連および時間に関連する書式設定情報を提供します。DateTimeFormatInfo supplies date-related and time-related formatting information, such as the position of the month, the day, and the year in a date pattern.

  • CultureInfo には、数値書式情報や日付関連の書式設定情報など、特定のカルチャの既定の書式情報が含まれています。CultureInfo contains the default formatting information in a specific culture, including the numeric format information, and date-related and time-related formatting information.

また、独自のカスタム書式プロバイダーを定義することもできます。In addition, you can define your own custom format provider.

注意 (実装者)

ToString(String, IFormatProvider) メソッドでは、"G" (general) 書式指定子をサポートする必要があります。The ToString(String, IFormatProvider) method must support the "G" (general) format specifier. "G" 指定子に加えて、クラスは、サポートする書式指定子のリストを定義できます。Besides the "G" specifier, the class can define the list of format specifiers that it supports. また、クラスは、nullされた書式指定子を処理できるように準備する必要があります。In addition, the class must be prepared to handle a format specifier that is null. 書式設定と書式設定のコードの詳細については、「型の書式設定」を参照してください。For more information about formatting and formatting codes, see Formatting Types.

適用対象

こちらもご覧ください