ICustomFormatter.Format-Methode

Artikel
08/20/2007

Konvertiert den Wert eines angegebenen Objekts unter Verwendung des angegebenen Formats und der kulturabhängigen Formatierungsinformationen in eine entsprechende Zeichenfolgenentsprechung.

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

Syntax

'Declaration
Function Format ( _
    format As String, _
    arg As Object, _
    formatProvider As IFormatProvider _
) As String
'Usage
Dim instance As ICustomFormatter
Dim format As String
Dim arg As Object
Dim formatProvider As IFormatProvider
Dim returnValue As String

returnValue = instance.Format(format, arg, formatProvider)

string Format (
    string format,
    Object arg,
    IFormatProvider formatProvider
)

String^ Format (
    String^ format, 
    Object^ arg, 
    IFormatProvider^ formatProvider
)

String Format (
    String format, 
    Object arg, 
    IFormatProvider formatProvider
)

function Format (
    format : String, 
    arg : Object, 
    formatProvider : IFormatProvider
) : String

Parameter

format
Eine Formatzeichenfolge mit Formatierungsangaben.

arg
Ein zu formatierendes Objekt.

formatProvider
Ein IFormatProvider-Objekt, das Formatinformationen über die aktuelle Instanz liefert.

Rückgabewert

Die Zeichenfolgenentsprechung des Werts von arg im durch format und formatProvider angegebenen Format.

Hinweise

Der format-Parameter enthält eine benutzerdefinierte Formatierungsangabe. Weitere Informationen über Standardformatierungsangaben in .NET Framework finden Sie unter Übersicht über Formatierung.

Verwenden Sie eine beliebige Standardformatierungsangabe, wenn format NULL (Nothing in Visual Basic) ist. Ignorieren Sie den formatProvider-Parameter, wenn dieser NULL (Nothing in Visual Basic) ist.

Die Implementierung der Format-Methode muss die folgende Funktionalität bieten, damit von .NET Framework eine Formatierung bereitgestellt werden kann, die ansonsten nicht unterstützt wird. Wenn die Formatierungsmethode ein Format nicht unterstützt, bestimmen Sie, ob das zu formatierende Objekt die IFormattable-Schnittstelle unterstützt. Wenn dies der Fall ist, rufen Sie die IFormattable.ToString-Methode dieser Schnittstelle auf. Rufen Sie andernfalls die Object.ToString-Standardmethode des zugrunde liegenden Objekts auf.

Das folgende C#-Codefragment veranschaulicht dieses Vorgehen für das Objekt arg, das Format format, den Formatanbieter formatProvider und den Rückgabewert s.

if (arg is IFormattable) s = ((IFormattable)arg).ToString(format, formatProvider);

else if (arg != null) s = arg.ToString();

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

ICustomFormatter-Schnittstelle
ICustomFormatter-Member
System-Namespace
IFormattable
Object

Share via