IFormattable.ToString(String, IFormatProvider) IFormattable.ToString(String, IFormatProvider) IFormattable.ToString(String, IFormatProvider) IFormattable.ToString(String, IFormatProvider) Method

定義

指定された書式を使用して現在のインスタンスの値を書式設定します。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 String String String

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

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

formatProvider
IFormatProvider IFormatProvider IFormatProvider 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.

次の例で、Temperatureを実装するクラス、ToStringメソッド。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})、渡されるnullの値として、System.Stringパラメーター。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.CurrentCultureの値として渡される、System.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 数値を 10 進数には、グループ区切り記号文字などの情報を書式設定し、スペル チェックと通貨値の通貨記号の配置を提供します。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"(一般) 書式指定子をサポートする必要があります。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.

適用対象

こちらもご覧ください