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

Параметры

Возвращаемое значение

Значение текущего экземпляра в указанном формате.

Примеры

В следующем примере демонстрируется 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) и Convert.ToString(Object, IFormatProvider) и методами, которые используют составную функцию форматирования в .NET Framework, например String.Format(String, Object[]), Console.WriteLine(String, Object[]) и StringBuilder.AppendFormat(String, Object[]). (Дополнительные сведения см. в разделе "Составное форматирование".)

Составные методы форматирования вызывают ToString метод один раз для каждого элемента формата в строке формата. Параметры, передаваемые методу, зависят от конкретного метода форматирования, вызываемого и содержимого элемента форматирования, как показано ниже.

• Если элемент формата не включает строку формата (например, если элемент формата просто {0}), он передается null в качестве значения System.String параметра.

• Если элемент формата содержит строку формата (например, {0:G}), эта строка форматирования передается в качестве значения System.String параметра.

• Если исходный вызов метода не включает System.IFormatProvider параметр, CultureInfo.CurrentCulture передается в качестве значения System.IFormatProvider параметра.

• Если исходный System.IFormatProvider вызов метода включает параметр, поставщик, предоставленный в вызове метода, передается в качестве значения System.IFormatProvider параметра.

Платформа .NET включает три поставщика формата, все из которых реализуют интерфейс IFormatProvider:

• NumberFormatInfo предоставляет числовые сведения о форматировании, такие как символы, используемые для разделителей десятичных и групповых разделителей, а также орфографию и размещение символов валют в денежных значениях.

• DateTimeFormatInfo предоставляет сведения о форматировании дат, связанных с датой и временем, например положение месяца, дня и года в шаблоне дат.

• CultureInfo содержит сведения о форматировании по умолчанию в определенном языке и региональных параметрах, включая сведения о числовом формате, а также сведения о форматировании, связанные с датой и временем.

Кроме того, можно определить собственный поставщик пользовательского формата.

Примечания для тех, кто реализует этот метод

Метод ToString(String, IFormatProvider) должен поддерживать описатель формата G (general). Помимо описателя "G" класс может определить список описателей формата, поддерживаемых им. Кроме того, класс должен быть готов к обработке описателя формата, который является null. Дополнительные сведения о форматировании и форматировании кодов см. в разделе "Типы форматирования".

См. также раздел

• String
• IFormatProvider
• NumberFormatInfo
• DateTimeFormatInfo
• CultureInfo