IFormattable.ToString(String, IFormatProvider) Yöntem

Tanım

Geçerli örneğin değerini belirtilen biçimi kullanarak biçimlendirir.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

Parametreler

format
String

Kullanılacak biçim.The format to use.

veya-or- IFormattable uygulamasının türü için tanımlanan varsayılan biçimi kullanmak için bir null başvurusu (Visual BasicNothing).A null reference (Nothing in Visual Basic) to use the default format defined for the type of the IFormattable implementation.

formatProvider
IFormatProvider

Değeri biçimlendirmek için kullanılacak sağlayıcı.The provider to use to format the value.

veya-or- İşletim sisteminin geçerli yerel ayar ayarından sayısal biçim bilgilerini almak için bir null başvurusu (Visual BasicNothing).A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.

Döndürülenler

Belirtilen biçimdeki geçerli örneğin değeri.The value of the current instance in the specified format.

Örnekler

Aşağıdaki örnek, ToString yöntemini uygulayan bir Temperature sınıfını gösterir.The following example demonstrates a Temperature class that implements the ToString method. Bu kod örneği, IFormattable sınıfı için sağlanan daha büyük bir örneğin parçasıdır.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

Açıklamalar

ToString yöntemi, bir değeri birden çok şekilde ifade edilebilir bir dize gösterimine dönüştürür.The ToString method converts a value to a string representation that can be expressed in multiple ways. Kesin biçimi belirli simgelere veya belirli kültürler, profesileri veya sektörlerle tanımlanan belirli bir sıraya bağlıdır.Its precise format depends on specific symbols or a specified order defined by specific cultures, professions, or industries. Yöntemini doğrudan çağırabilirsiniz.You can call the method directly. Ayrıca, Convert.ToString(Object) ve Convert.ToString(Object, IFormatProvider) yöntemleri tarafından ve String.Format(String, Object[]), Console.WriteLine(String, Object[])ve StringBuilder.AppendFormat(String, Object[])gibi .NET Framework bileşik biçimlendirme özelliğini kullanan yöntemler tarafından otomatik olarak çağrılır.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[]). (Daha fazla bilgi için bkz. Bileşik biçimlendirme.)(For more information, see Composite Formatting.)

Bileşik biçimlendirme yöntemleri, bir biçim dizesindeki her biçim öğesi için ToString yöntemini bir kez çağırır.Composite formatting methods call the ToString method once for each format item in a format string. Yöntemine geçirilen parametreler, aşağıdaki gibi, olarak adlandırılan belirli biçimlendirme yöntemine ve biçim öğesinin içeriğine bağlıdır: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:

Not

Bir nesnenin ToString uygulamasına bileşik biçimlendirme yöntemleri, yalnızca bir ICustomFormatter biçim sağlayıcısı geçirmemişse veya özel biçim sağlayıcısının Format yöntemi nulldöndürürse çağrılır.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, hepsi IFormatProvider arabirimini uygulayan üç biçim sağlayıcısı içerir:The .NET Framework includes three format providers, all of which implement the IFormatProvider interface:

  • NumberFormatInfo, ondalık ve grup ayırıcıları için kullanılacak karakterler ve parasal değerlerde para birimi simgelerinin yazım ve yerleşimini sağlayan sayısal biçimlendirme bilgilerini sağlar.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, günün konumu, günü ve Tarih deseninin yılı gibi tarih ile ilgili ve zaman ile ilgili biçimlendirme bilgilerini sağlar.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, belirli bir kültürde sayısal biçim bilgileri ve Tarih ile ilgili ve zaman ile ilgili biçimlendirme bilgileri de dahil olmak üzere varsayılan biçimlendirme bilgilerini içerir.CultureInfo contains the default formatting information in a specific culture, including the numeric format information, and date-related and time-related formatting information.

Ayrıca, kendi özel biçim sağlayıcınızı tanımlayabilirsiniz.In addition, you can define your own custom format provider.

Uygulayanlara Notlar

ToString(String, IFormatProvider) yöntemi "G" (genel) biçim belirticisini desteklemelidir.The ToString(String, IFormatProvider) method must support the "G" (general) format specifier. "G" belirticisinin yanı sıra, sınıfı desteklediği biçim belirticileri listesini tanımlayabilir.Besides the "G" specifier, the class can define the list of format specifiers that it supports. Ayrıca, sınıfının nullbir biçim belirticisini işleyecek şekilde hazırlanmalıdır.In addition, the class must be prepared to handle a format specifier that is null. Biçimlendirme ve biçimlendirme kodları hakkında daha fazla bilgi için bkz. biçimlendirme türleri.For more information about formatting and formatting codes, see Formatting Types.

Şunlara uygulanır

Ayrıca bkz.