IFormattable.ToString-Methode

Formatiert den Wert der aktuellen Instanz unter Verwendung des angegebenen Formats.

Namespace: System
Assembly: mscorlib (in mscorlib.dll)

Syntax

'Declaration
Function ToString ( _
    format As String, _
    formatProvider As IFormatProvider _
) As String
'Usage
Dim instance As IFormattable
Dim format As String
Dim formatProvider As IFormatProvider
Dim returnValue As String

returnValue = instance.ToString(format, formatProvider)

string ToString (
    string format,
    IFormatProvider formatProvider
)

String^ ToString (
    String^ format, 
    IFormatProvider^ formatProvider
)

String ToString (
    String format, 
    IFormatProvider formatProvider
)

function ToString (
    format : String, 
    formatProvider : IFormatProvider
) : String

Parameter

• format
  Der String, der das zu verwendende Format angibt.

  – oder –

  NULL (Nothing in Visual Basic), wenn das für diese Art der IFormattable-Implementierung definierte Standardformat verwendet werden soll.

• formatProvider
  Der zum Formatieren des Werts zu verwendende IFormatProvider.

  – oder –

  NULL (Nothing in Visual Basic), wenn die Informationen über numerische Formate dem aktuellen Gebietsschema des Betriebssystems entnommen werden sollen.

Rückgabewert

Ein String mit dem Wert der aktuellen Instanz im angegebenen Format.

Hinweise

NumberFormatInfo, DateTimeFormatInfo und CultureInfo implementieren die IFormatProvider-Schnittstelle.

NumberFormatInfo liefert Informationen, z. B. die zu verwendenden Zeichen für Dezimal- und Tausendertrennzeichen oder die Schreibweise und Position von Währungssymbolen bei Währungswerten.

DateTimeFormatInfo liefert Informationen über die Formatierung von Datums- und Zeitangaben, z. B. die Position für Monat, Tag und Jahr in einem Datum.

CultureInfo enthält die Standardformatierungsinformationen für eine bestimmte Kultur. Dazu gehören Informationen über numerische Formate und über Formate, die mit Datums- und Zeitangaben zusammenhängen.

Beispiel

Im folgenden Codebeispiel wird das Implementieren der ToString-Methode veranschaulicht. Dieses Codebeispiel ist Teil eines umfangreicheren Beispiels für die IFormattable-Klasse.

public override String ToString() { return ToString(null, null); }

public String ToString(String format, IFormatProvider fp)
{
    // If no format is passed, display like this: (x, y).
    if (format == null) return String.Format("({0}, {1})", x, y);

    // For "x" formatting, return just the x value as a string
    if (format == "x") return x.ToString();

    // For "y" formatting, return just the y value as a string
    if (format == "y") return y.ToString();

    // For any unrecognized format, throw an exception.
    throw new FormatException(String.Format("Invalid format string: '{0}'.", format));
}

public:
    virtual String^ ToString() override
    {
        return ToString(nullptr, nullptr);
    }

public:
    virtual String^ ToString(String^ format, IFormatProvider^ formatProvider)
    {
        // If no format is passed, display like this: (x, y).
        if (format == nullptr)
        {
            return String::Format("({0}, {1})", x, y);
        }

        // For "x" formatting, return just the x value as a string
        if (format == "x")
        {
            return x.ToString();
        }

        // For "y" formatting, return just the y value as a string
        if (format == "y")
        {
            return y.ToString();
        }

        // For any unrecognized format, throw an exception.
        throw gcnew FormatException(String::Format(
            "Invalid format string: '{0}'.", format));
    }

Plattformen

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile für Pocket PC, Windows Mobile für Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

.NET Framework unterstützt nicht alle Versionen sämtlicher Plattformen. Eine Liste der unterstützten Versionen finden Sie unter Systemanforderungen.

Versionsinformationen

.NET Framework

Unterstützt in: 2.0, 1.1, 1.0

.NET Compact Framework

Unterstützt in: 2.0, 1.0

Siehe auch

Referenz

IFormattable-Schnittstelle
IFormattable-Member
System-Namespace
String
IFormatProvider-Schnittstelle
System.Globalization.NumberFormatInfo
System.Globalization.DateTimeFormatInfo
System.Globalization.CultureInfo