IFormattable.ToString(String, IFormatProvider) Metoda

Definice

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

public string ToString (string format, IFormatProvider formatProvider);
public string ToString (string? format, IFormatProvider? formatProvider);

Parametry

format
String

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

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

formatProvider
IFormatProvider

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

-nebo- Odkaz na hodnotu null (Nothingv Visual Basic) pro 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 zadaného IFormattable pro třídu.

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));
      }
   }
}

Poznámky

Metoda ToString převede hodnotu na řetězcovou reprezentaci, kterou 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í kulturou, povoláním nebo odvětvím. Metodu můžete volat přímo. Volá se také automaticky metodami Convert.ToString(Object) a metodami, které používají složenou funkci formátování v .NET Framework, například String.Format(String, Object[]), a Console.WriteLine(String, Object[])StringBuilder.AppendFormat(String, Object[]).Convert.ToString(Object, IFormatProvider) (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á se volá, a na obsahu položky formátu následujícím způsobem:

Poznámka

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 zprostředkovatele vlastního formátu vrátí null.

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

  • NumberFormatInfo poskytuje číselné formátování informací, jako jsou 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 v 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 k zpracování specifikátoru formátu, který je null. Další informace o formátování a formátování kódů najdete v tématu Typy formátování.

Platí pro

Viz také