Diese Dokumentation wurde archiviert und wird nicht länger gepflegt.

ICustomFormatter.Format-Methode

Aktualisiert: November 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)

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
Typ: System.String
Eine Formatzeichenfolge mit Formatierungsangaben.
arg
Typ: System.Object
Ein zu formatierendes Objekt.
formatProvider
Typ: System.IFormatProvider
Ein IFormatProvider-Objekt, das Formatinformationen über die aktuelle Instanz liefert.

Rückgabewert

Typ: System.String
Die Zeichenfolgenentsprechung des Werts von arg im durch format und formatProvider angegebenen Format.

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 formatnull ist. Ignorieren Sie den formatProvider-Parameter, wenn dieser null 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();

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

.NET Framework und .NET Compact Framework unterstützen nicht alle Versionen sämtlicher Plattformen. Eine Liste der unterstützten Versionen finden Sie unter Systemanforderungen für .NET Framework.

.NET Framework

Unterstützt in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Unterstützt in: 3.5, 2.0, 1.0

XNA Framework

Unterstützt in: 2.0, 1.0
Anzeigen: