IFormattable.ToString(String, IFormatProvider) Method

Definition

Zformátuje hodnotu aktuální instance pomocí zadaného formátu.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

Parameters

format
String

Formát, který se má použít.The format to use.

-nebo--or- Odkaz s hodnotou null (Nothing v Visual Basic) pro použití výchozího formátu definovaného pro typ IFormattable implementace.A null reference (Nothing in Visual Basic) to use the default format defined for the type of the IFormattable implementation.

formatProvider
IFormatProvider

Poskytovatel, který má být použit k formátování hodnoty.The provider to use to format the value.

-nebo--or- Odkaz s hodnotou 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.A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.

Returns

String

Hodnota aktuální instance v zadaném formátu.The value of the current instance in the specified format.

Examples

Následující příklad ukazuje třídu Temperature, která implementuje metodu ToString.The following example demonstrates a Temperature class that implements the ToString method. Tato ukázka kódu je součástí většího příkladu vztahujícího se ke třídě 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

Remarks

Metoda ToString převede hodnotu na řetězcovou reprezentaci, kterou lze vyjádřit různými způsoby.The ToString method converts a value to a string representation that can be expressed in multiple ways. Jeho přesný formát závisí na konkrétních symbolech nebo na určitém pořadí definovaném konkrétními kulturami, odborníky nebo průmyslovými odvětvími.Its precise format depends on specific symbols or a specified order defined by specific cultures, professions, or industries. Metodu lze volat přímo.You can call the method directly. Také je volána automaticky Convert.ToString(Object) a Convert.ToString(Object, IFormatProvider) metodou a metodami, které používají funkci složeného formátování v .NET Framework, například String.Format(String, Object[]), Console.WriteLine(String, Object[])a 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[]). (Další informace najdete v tématu složené formátování.)(For more information, see Composite Formatting.)

Metody složeného formátování volají metodu ToString jednou pro každou položku formátu v řetězci formátu.Composite formatting methods call the ToString method once for each format item in a format string. Parametry předané metodě závisí na konkrétní metodě formátování, která je volána, a na obsahu položky formátu, jak je znázorněno níže: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:

Note

Implementace ToString objektu je volána pomocí metod složeného formátování pouze v případě, že nejsou předány poskytovateli ICustomFormatterho formátu nebo pokud metoda Format vlastního zprostředkovatele formátu vrátí null.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 obsahuje tři poskytovatele formátu, všechny implementující rozhraní IFormatProvider:The .NET Framework includes three format providers, all of which implement the IFormatProvider interface:

  • NumberFormatInfo poskytuje informace o formátování číselných formátů, 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.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 poskytuje informace o formátování související s datem a časem, jako je pozice měsíce, den a rok v rámci vzoru data.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 obsahuje výchozí informace o formátování v konkrétní jazykové verzi, včetně informací o číselném formátu a informace o formátování související s datem a časem.CultureInfo contains the default formatting information in a specific culture, including the numeric format information, and date-related and time-related formatting information.

Kromě toho můžete definovat vlastního poskytovatele vlastního formátu.In addition, you can define your own custom format provider.

Notes to Implementers

Metoda ToString(String, IFormatProvider) musí podporovat specifikátor formátu "G" (Obecné).The ToString(String, IFormatProvider) method must support the "G" (general) format specifier. Kromě specifikátoru "G" může třída definovat seznam specifikátorů formátu, které podporuje.Besides the "G" specifier, the class can define the list of format specifiers that it supports. Kromě toho musí být třída připravena pro zpracování specifikátoru formátu, který je null.In addition, the class must be prepared to handle a format specifier that is null. Další informace o formátování a formátování kódu naleznete v tématu Formatting Types.For more information about formatting and formatting codes, see Formatting Types.

Applies to

See also