IFormattable.ToString(String, IFormatProvider) Metoda

Definicja

Formatuje wartość bieżącego wystąpienia w określonym formacie.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);
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

Format do użycia.The format to use.

-lub--or- Odwołanie o wartości null ( Nothing w Visual Basic) do użycia domyślnego formatu zdefiniowanego dla typu IFormattable implementacji.A null reference (Nothing in Visual Basic) to use the default format defined for the type of the IFormattable implementation.

formatProvider
IFormatProvider

Dostawca służący do formatowania wartości.The provider to use to format the value.

-lub--or- Odwołanie o wartości null ( Nothing w Visual Basic), aby uzyskać informacje o formacie liczbowym z bieżących ustawień regionalnych systemu operacyjnego.A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.

Zwraca

String

Wartość bieżącego wystąpienia w określonym formacie.The value of the current instance in the specified format.

Przykłady

Poniższy przykład ilustruje Temperature klasę, która implementuje ToString metodę.The following example demonstrates a Temperature class that implements the ToString method. Ten przykład kodu jest częścią większego przykładu dostarczonego dla IFormattable klasy.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

Uwagi

ToStringMetoda konwertuje wartość na reprezentację w postaci ciągu, która może być wyrażona na wiele sposobów.The ToString method converts a value to a string representation that can be expressed in multiple ways. Dokładny format zależy od określonych symboli lub określonej kolejności zdefiniowanej przez określone kultury, zawody lub branże.Its precise format depends on specific symbols or a specified order defined by specific cultures, professions, or industries. Metodę można wywołać bezpośrednio.You can call the method directly. Jest on również wywoływany automatycznie przez Convert.ToString(Object) Convert.ToString(Object, IFormatProvider) metody i i metodami korzystającymi z funkcji formatowania złożonego w .NET Framework, takich jak String.Format(String, Object[]) , Console.WriteLine(String, Object[]) , i 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[]). (Aby uzyskać więcej informacji, zobacz formatowanie złożone).(For more information, see Composite Formatting.)

Metody formatowania złożonego wywołują ToString metodę jednokrotnie dla każdego elementu formatu w ciągu formatu.Composite formatting methods call the ToString method once for each format item in a format string. Parametry przesłane do metody zależą od określonej metody formatowania, która jest wywoływana i dla zawartości elementu format, w następujący sposób: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:

Uwaga

ToStringImplementacja obiektu jest nazywana metodami formatowania złożonego tylko wtedy, gdy nie przechodzą ICustomFormatter dostawcy formatowania lub Format Metoda zwraca dostawcę formatowania niestandardowego 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 obejmuje trzy dostawców formatów, z których wszystkie implementują IFormatProvider Interfejs:The .NET Framework includes three format providers, all of which implement the IFormatProvider interface:

  • NumberFormatInfo dostarcza informacje o formatowaniu liczb, takie jak znaki, które mają być używane dla separatorów dziesiętnych i grup, oraz pisownię i rozmieszczenie symboli walut w wartościach pieniężnych.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 dostarcza informacje dotyczące formatowania powiązane z datami i czasu, takie jak pozycja miesiąca, dzień i rok w wzorcu daty.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 zawiera domyślne informacje o formatowaniu w określonej kulturze, w tym informacje o formacie liczbowym oraz informacje dotyczące formatowania powiązane z datami i czasowo.CultureInfo contains the default formatting information in a specific culture, including the numeric format information, and date-related and time-related formatting information.

Ponadto można zdefiniować własnego niestandardowego dostawcy formatu.In addition, you can define your own custom format provider.

Uwagi dotyczące implementowania

ToString(String, IFormatProvider)Metoda musi obsługiwać specyfikator formatu "G" (ogólne).The ToString(String, IFormatProvider) method must support the "G" (general) format specifier. Oprócz specyfikatora "G", Klasa może definiować listę specyfikatorów formatu, które obsługuje.Besides the "G" specifier, the class can define the list of format specifiers that it supports. Ponadto Klasa musi być przygotowana do obsługi specyfikatora formatu null .In addition, the class must be prepared to handle a format specifier that is null. Aby uzyskać więcej informacji na temat formatowania i formatowania kodów, zobacz Typy formatowania.For more information about formatting and formatting codes, see Formatting Types.

Dotyczy

Zobacz też