IFormattable.ToString(String, IFormatProvider) Yöntem

Tanım

Ad Alanı:

System

Bütünleştirilmiş Kod:

System.Runtime.dll

Bütünleştirilmiş Kod:

mscorlib.dll

Bütünleştirilmiş Kod:

netstandard.dll

Belirtilen biçimi kullanarak geçerli örneğin değerini biçimlendirebilir.

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

Parametreler

format

String

Kullanılacak biçim.

-veya- Uygulama türü IFormattable için tanımlanan varsayılan biçimi kullanmak için null başvuru (NothingVisual Basic) .

formatProvider

IFormatProvider

Değeri biçimlendirmek için kullanılacak sağlayıcı.

-veya- İşletim sisteminin geçerli yerel ayarından sayısal biçim bilgilerini almak için null başvuru (NothingVisual Basic).

Döndürülenler

String

Belirtilen biçimdeki geçerli örneğin değeri.

Örnekler

Aşağıdaki örnekte yöntemini uygulayan bir Temperature sınıf gösterilmektedir ToString . Bu kod örneği, sınıfı için IFormattable sağlanan daha büyük bir örneğin parçasıdır.

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

Açıklamalar

yöntemi, ToString bir değeri birden çok yolla ifade edilebilen bir dize gösterimine dönüştürür. Kesin biçimi belirli simgelere veya belirli kültürler, meslekler veya sektörler tarafından tanımlanan belirli bir düzene bağlıdır. yöntemini doğrudan çağırabilirsiniz. Ayrıca ve yöntemleri ve Convert.ToString(Object) Convert.ToString(Object, IFormatProvider) .NET Framework bileşik biçimlendirme özelliğini kullanan yöntemler tarafından da otomatik olarak çağrılır; örneğinString.Format(String, Object[]), , Console.WriteLine(String, Object[])ve StringBuilder.AppendFormat(String, Object[]). (Daha fazla bilgi için bkz . Bileşik Biçimlendirme.)

Bileşik biçimlendirme yöntemleri, bir biçim dizesindeki ToString her biçim öğesi için yöntemini bir kez çağırır. yöntemine geçirilen parametreler, aşağıdaki gibi çağrılan belirli biçimlendirme yöntemine ve biçim öğesinin içeriğine bağlıdır:

• Biçim öğesi bir biçim dizesi içermiyorsa (örneğin, biçim öğesi basitse{0}), parametrenin System.String değeri olarak geçirilirnull.

• Biçim öğesi bir biçim dizesi içeriyorsa (örneğin, {0:G}), bu biçim dizesi parametrenin System.String değeri olarak geçirilir.

• Özgün yöntem çağrısı bir System.IFormatProvider parametre içermiyorsa, CultureInfo.CurrentCulture parametresinin System.IFormatProvider değeri olarak geçirilir.

• Özgün yöntem çağrısı bir System.IFormatProvider parametre içeriyorsa, yöntem çağrısında sağlanan sağlayıcı parametresinin System.IFormatProvider değeri olarak geçirilir.

Not

Nesnenin ToString uygulaması, yalnızca bir ICustomFormatter biçim sağlayıcısı geçirilmediklerinde veya özel biçim sağlayıcısının yöntemi döndürdüğünde Format bileşik biçimlendirme yöntemleri tarafından çağrılır null.

.NET Framework, tümü arabirimini uygulayan IFormatProvider üç biçim sağlayıcısı içerir:

• NumberFormatInfo ondalık ve grup ayırıcıları için kullanılacak karakterler ve para birimi simgelerinin parasal değerlerde yazım ve yerleşimi gibi sayısal biçimlendirme bilgileri sağlar.

• DateTimeFormatInfo ayın konumu, gün ve yıl gibi tarihle ve saatle ilgili biçimlendirme bilgilerini bir tarih düzeninde sağlar.

• CultureInfo , sayısal biçim bilgileri ve tarihle ilgili ve saatle ilgili biçimlendirme bilgileri de dahil olmak üzere belirli bir kültürdeki varsayılan biçimlendirme bilgilerini içerir.

Ayrıca, kendi özel biçim sağlayıcınızı tanımlayabilirsiniz.

Uygulayanlara Notlar

Yöntemin ToString(String, IFormatProvider) "G" (genel) biçim tanımlayıcısını desteklemesi gerekir. "G" tanımlayıcısının yanı sıra, sınıfı desteklediği biçim tanımlayıcıları listesini tanımlayabilir. Buna ek olarak, sınıfı olan bir biçim tanımlayıcısını nullişlemek için hazır olmalıdır. Biçimlendirme ve biçimlendirme kodları hakkında daha fazla bilgi için bkz. Biçimlendirme Türleri.

Ayrıca bkz.

• String
• IFormatProvider
• NumberFormatInfo
• DateTimeFormatInfo
• CultureInfo