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

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

Параметры

Возвраты

Примеры

В следующем примере демонстрируется 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.

.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» (Общие) формате.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.

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

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

• String String String String
• IFormatProvider IFormatProvider IFormatProvider IFormatProvider
• NumberFormatInfo
• DateTimeFormatInfo
• CultureInfo