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

Используемый формат.

-или- Пустая (null) ссылка (Nothing в Visual Basic) для использования формата по умолчанию, заданного для типа реализации IFormattable.

formatProvider
IFormatProvider

Поставщик, используемый для форматирования значения.

-или- Пустая (null) ссылка (Nothing в Visual Basic) для получения сведений о числовом формате из параметра текущего языка операционной системы.

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

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Метод преобразует значение в строковое представление, которое может быть выражено несколькими способами. Его точный формат зависит от конкретных символов или определенного порядка, определенного в определенных культурах, профессиях или отраслях. Метод можно вызвать напрямую. он также вызывается автоматически 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 параметра.

Примечание

ToStringРеализация объекта вызывается методами составного форматирования только в том случае, если они не передаются ICustomFormatter поставщику формата или если Format метод поставщика пользовательского формата возвращает null .

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

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

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

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

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

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

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

Применяется к

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