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));
      }
   }
}
open System
open System.Globalization

type Temperature(temperature: decimal) =
    do 
        if temperature < -273.15M then
            raise (ArgumentOutOfRangeException $"{temperature} is less than absolute zero.")

    member _.Celsius =
        temperature

    member _.Fahrenheit =
        temperature * 9M / 5M + 32M

    member _.Kelvin =
        temperature + 273.15m

    override this.ToString() =
        this.ToString("G", CultureInfo.CurrentCulture)

    member this.ToString(format) =
        this.ToString(format, CultureInfo.CurrentCulture)

    member this.ToString(format, provider: IFormatProvider) =
        let format =
            if String.IsNullOrEmpty format then "G"
            else format

        let provider =
            if isNull provider then 
                CultureInfo.CurrentCulture :> IFormatProvider
            else provider

        match format.ToUpperInvariant() with
        | "G" | "C" ->
            temperature.ToString("F2", provider) + " °C"
        | "F" ->
            this.Fahrenheit.ToString("F2", provider) + " °F"
        | "K" ->
            this.Kelvin.ToString("F2", provider) + " K"
        | _ ->
            raise (FormatException $"The {format} format string is not supported.")

    interface IFormattable with
        member this.ToString(format, provider) = this.ToString(format, provider)
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 、複数の方法で表現できる文字列表現に値を変換します。 その正確な形式は、特定のシンボルまたは特定の文化、職業、または業界によって定義された指定された順序に依存します。 メソッドを直接呼び出すことができます。 また、メソッドやConvert.ToString(Object, IFormatProvider)、.NET Frameworkで複合書式指定機能を使用するメソッド (例: String.Format(String, Object[]),Console.WriteLine(String, Object[])、.) によってConvert.ToString(Object)自動的に呼び出されますStringBuilder.AppendFormat(String, Object[])。 (詳細については、「 複合書式」を参照してください)。

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

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

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

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

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

注意

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

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

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

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

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

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

注意 (実装者)

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

適用対象

こちらもご覧ください