IFormattable.ToString(String, IFormatProvider) IFormattable.ToString(String, IFormatProvider) IFormattable.ToString(String, IFormatProvider) IFormattable.ToString(String, IFormatProvider) Method

Definition

Formatiert den Wert der aktuellen Instanz mit dem angegebenen Format.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

Parameter

format
String String String String

Das zu verwendende Format.The format to use.

- oder - -or- Ein NULL-Verweis (Nothing in Visual Basic), wenn das für den Typ der IFormattable -Implementierung definierte Standardformat verwendet werden soll.A null reference (Nothing in Visual Basic) to use the default format defined for the type of the IFormattable implementation.

formatProvider
IFormatProvider IFormatProvider IFormatProvider IFormatProvider

Der zum Formatieren des Werts zu verwendende Anbieter.The provider to use to format the value.

- oder - -or- Ein NULL-Verweis (Nothing in Visual Basic), wenn die Informationen über numerische Formate dem aktuellen Gebietsschema des Betriebssystems entnommen werden sollen.A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.

Gibt zurück

Der Wert der aktuellen Instanz im angegebenen Format.The value of the current instance in the specified format.

Beispiele

Das folgende Beispiel zeigt eine Temperature Klasse, die implementiert die ToString Methode.The following example demonstrates a Temperature class that implements the ToString method. Dieses Codebeispiel ist Teil eines umfangreicheren Beispiels für die IFormattable Klasse.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

Hinweise

Die ToString Methode konvertiert einen Wert in eine Zeichenfolgendarstellung, die auf verschiedene Weise ausgedrückt werden kann.The ToString method converts a value to a string representation that can be expressed in multiple ways. Das genaue Format hängt davon ab, bestimmte Symbole oder einer bestimmten Reihenfolge, die durch bestimmte Kulturen, Berufe oder Branchen definiert.Its precise format depends on specific symbols or a specified order defined by specific cultures, professions, or industries. Sie können die Methode direkt aufrufen.You can call the method directly. Es heißt auch automatisch von der Convert.ToString(Object) und Convert.ToString(Object, IFormatProvider) Methoden und durch Methoden, die die kombinierte Formatierung verwenden von Features in .NET Framework, z. B. String.Format(String, Object[]), Console.WriteLine(String, Object[]), und 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[]). (Weitere Informationen finden Sie unter kombinierte Formatierung.)(For more information, see Composite Formatting.)

Kombinierte Formatierung von Methoden der ToString Methode einmal für jedes Formatelement in einer Formatzeichenfolge.Composite formatting methods call the ToString method once for each format item in a format string. Die an die Methode übergebenen Parameter hängen bestimmte Formatierungsmethode auf, die aufgerufen wird und der Inhalt des Formatelements, wie folgt: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:

  • Wenn es sich bei dem Formatelement, das eine Formatzeichenfolge nicht enthalten ist (z. B., wenn dem Formatelement, das einfach ist {0}), wird übergeben null als Wert für die System.String Parameter.If the format item does not include a format string (for example, if the format item is simply {0}), it is passed null as the value of the System.String parameter.

  • Wenn es sich bei dem Formatelement, das eine Formatzeichenfolge enthält (z. B. {0:G}), dass als Wert für Formatzeichenfolge übergeben wird die System.String Parameter.If the format item includes a format string (for example, {0:G}), that format string is passed as the value of the System.String parameter.

  • Wenn der ursprüngliche Methodenaufruf nicht enthalten ist ein System.IFormatProvider Parameter CultureInfo.CurrentCulture übergeben wird, als Wert für die System.IFormatProvider Parameter.If the original method call does not include an System.IFormatProvider parameter, CultureInfo.CurrentCulture is passed as the value of the System.IFormatProvider parameter.

  • Wenn der ursprüngliche Methodenaufruf enthält ein System.IFormatProvider Parameter, der Anbieter, die im Aufruf Methode bereitgestellt werden wird übergeben als Wert für die System.IFormatProvider Parameter.If the original method call includes an System.IFormatProvider parameter, the provider that is supplied in the method call is passed as the value of the System.IFormatProvider parameter.

Hinweis

Eines Objekts ToString Implementierung wird von Methoden zur kombinierten Formatierung nur aufgerufen, wenn sie nicht übergeben werden ein ICustomFormatter Formatanbieter verwendet, oder wenn die Format Methodenrückgabe des benutzerdefinierten Formatanbieters 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 enthält drei Formatanbieter alle implementieren die IFormatProvider Schnittstelle:The .NET Framework includes three format providers, all of which implement the IFormatProvider interface:

  • NumberFormatInfo Liefert Informationen, z. B. die Zeichen für Dezimalzahl und Gruppentrennzeichen, und die Schreibweise und Platzierung der Währungssymbole in monetäre Werte.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 Liefert Informationen über die Formatierung von Datums- und Zeitangaben beziehen, z. B. die Position des Monats, den Tag und Jahr in einem Datum.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 enthält die standardformatierung Informationen in einer bestimmten Kultur, einschließlich der Informationen numerisches Format und Formatierungsinformationen für Datums- und Zeitangaben beziehen.CultureInfo contains the default formatting information in a specific culture, including the numeric format information, and date-related and time-related formatting information.

Darüber hinaus können Sie Ihre eigenen benutzerdefinierten Formatanbieters definieren.In addition, you can define your own custom format provider.

Hinweise für Ausführende

Die ToString(String, IFormatProvider) -Methode muss den (Allgemein) Formatbezeichner "G" unterstützen.The ToString(String, IFormatProvider) method must support the "G" (general) format specifier. Neben der Formatbezeichner "G" kann die Klasse die Liste der Formatbezeichner definieren, die es unterstützt.Besides the "G" specifier, the class can define the list of format specifiers that it supports. Darüber hinaus muss die Klasse vorbereitet werden, einen Formatbezeichner, um behandeln null.In addition, the class must be prepared to handle a format specifier that is null. Weitere Informationen zur Formatierung und Formatierungscodes finden Sie unter Formatierung von Typen.For more information about formatting and formatting codes, see Formatting Types.

Gilt für:

Siehe auch