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 в 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- Пустая ссылка (Nothing в Visual Basic) для получения сведений о формате чисел из текущего установленного в операционной системе языкового стандарта.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 метод один раз для каждого элемента форматирования в строке формата.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 включает три поставщика формата, все из которых реализуют 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.

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

Дополнительно