IFormattable.ToString(String, IFormatProvider) Metoda

Definice

Obor názvů:

System

Sestavení:

netstandard.dll, System.Runtime.dll

Zdroj:

IFormattable.cs

Naformátuje hodnotu aktuální instance pomocí zadaného formátu.

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

Parametry

format

String

Formát, který se má použít.

nebo

Odkaz null (Nothing v Visual Basic) pro použití výchozího formátu definovaného pro typ implementace IFormattable.

formatProvider

IFormatProvider

Zprostředkovatel, který se má použít k formátování hodnoty.

nebo

Odkaz null (Nothing v Visual Basic) k získání informací o číselném formátu z aktuálního nastavení národního prostředí operačního systému.

Návraty

String

Hodnota aktuální instance v zadaném formátu.

Příklady

Následující příklad ukazuje Temperature třídu, která implementuje metodu ToString . Tento příklad kódu je součástí většího příkladu uvedeného pro třídu 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));
      }
   }
}

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

Poznámky

Metoda ToString převede hodnotu na řetězcové vyjádření, které lze vyjádřit několika způsoby. Přesný formát závisí na konkrétních symbolech nebo zadaném pořadí definovaném konkrétními kulturami, povoláními nebo odvětvími. Metodu můžete volat přímo. Volá se také automaticky metodami Convert.ToString(Object) a Convert.ToString(Object, IFormatProvider) a metodami, které používají funkci složeného formátování v rozhraní .NET Framework, například String.Format(String, Object[]), Console.WriteLine(String, Object[]) a StringBuilder.AppendFormat(String, Object[]). (Další informace najdete v tématu Složené formátování.)

Složené metody formátování volají metodu ToString jednou pro každou položku formátu v řetězci formátu. Parametry předané metodě závisí na konkrétní metodě formátování, která je volána, a na obsahu položky formátu následujícím způsobem:

• Pokud položka formátu neobsahuje formátovací řetězec (například pokud je položka formátu jednoduše {0}), předá null se jako hodnota parametru System.String .

• Pokud položka formátu obsahuje formátovací řetězec (například {0:G}), tento formátovací řetězec se předává jako hodnota parametru System.String .

• Pokud původní volání metody neobsahuje System.IFormatProvider parametr, CultureInfo.CurrentCulture je předán jako hodnota parametru System.IFormatProvider .

• Pokud původní volání metody obsahuje System.IFormatProvider parametr, zprostředkovatel zadaný ve volání metody se předá jako hodnota parametru System.IFormatProvider .

Note

Implementace objektu ToString je volána složenými metodami formátování pouze v případě, že nejsou předány ICustomFormatter zprostředkovatele formátu, nebo pokud Format metoda vlastního formátu zprostředkovatel vrátí null.

Rozhraní .NET Framework obsahuje tři zprostředkovatele formátu, z nichž všichni implementují rozhraní IFormatProvider:

• NumberFormatInfo poskytuje číselné informace o formátování, například znaky, které se mají použít pro oddělovače desetinných míst a skupin, a pravopis a umístění symbolů měny v peněžních hodnotách.

• DateTimeFormatInfo poskytuje informace o formátování související s datem a časem, jako je pozice měsíce, dne a roku ve vzoru kalendářního data.

• CultureInfo obsahuje výchozí informace o formátování v konkrétní jazykové verzi, včetně informací o číselném formátu a informací o formátování souvisejících s datem a časem.

Kromě toho můžete definovat vlastního zprostředkovatele formátu.

Poznámky pro implementátory

Metoda ToString(String, IFormatProvider) musí podporovat specifikátor formátu "G" (obecný). Kromě specifikátoru "G" může třída definovat seznam specifikátorů formátu, které podporuje. Kromě toho musí být třída připravena na zpracování specifikátoru formátu, který je null. Další informace o formátování a formátování kódů naleznete v tématu Typy formátování.

Viz také

• String
• IFormatProvider
• NumberFormatInfo
• DateTimeFormatInfo
• CultureInfo