CKTIS / C#
IFormattable — Werte mit einem Formatprovider formatieren
System.IFormattable definiert die Umwandlung eines Werts in Text anhand einer Formatzeichenfolge und eines Providers für Formatierungsinformationen. Dadurch können eigene Typen an zusammengesetzter Formatierung wie string.Format teilnehmen, statt sich nur auf parameterloses ToString() zu stützen.
Version: .NET 10; repository net10.0 and LangVersion=preview; feature versions require per-entry verification
Syntax
public interface IFormattable
{
string ToString(string? format, IFormatProvider? formatProvider);
}System.IFormattable enthält eine Methode: IFormattable.ToString(string? format, IFormatProvider? formatProvider). Der Parameter format wählt die Darstellung des Werts aus, während formatProvider Formatierungsinformationen bereitstellt, etwa das Dezimaltrennzeichen. Dies ist ein Bibliotheksvertrag, der in .NET 10 verfügbar ist, und keine Funktion, für die C# im Preview-Modus erforderlich ist.
Eine Implementierung muss "G" (allgemeines Format) und null als Standardformat unterstützen. Das Beispiel behandelt außerdem eine leere Zeichenfolge wie "G", verwendet bei einem null-Provider CultureInfo.CurrentCulture und weist nicht unterstützte Formate mit FormatException zurück. Welche zusätzlichen Formate verfügbar sind, legt der Typ fest: Die Implementierung der Schnittstelle bietet nicht automatisch Unterstützung für alle Zahlenformate.
Die Überladung mit zwei Parametern ersetzt object.ToString() nicht. Im Beispiel delegiert eine separate Überschreibung des parameterlosen ToString() an die gemeinsame Implementierung. string.Format übergibt ihr das Format eines Elements wie {0:F2} sowie den Provider. Ein Provider mit ICustomFormatter kann die Formatierung jedoch übernehmen; die Methode des Objekts wird verwendet, wenn dieser Mechanismus den Wert nicht verarbeitet.
Der Typ Distance unterstützt genau "G" und "F2" sowie die Standardwerte null und leere Zeichenfolge. Beim Formatieren seines zugrunde liegenden decimal-Werts gibt er den Provider weiter. Beide Aufrufe verwenden CultureInfo.InvariantCulture; daher lauten die erwarteten Zeilen unabhängig von der aktuellen Kultur 12.5 m und 12.50 m.
Beispiele
#nullable enable
using System;
using System.Globalization;
var distance = new Distance(12.5m);
IFormattable value = distance;
Console.WriteLine(value.ToString(null, CultureInfo.InvariantCulture));
Console.WriteLine(string.Format(CultureInfo.InvariantCulture, "{0:F2}", distance));
public sealed class Distance : IFormattable
{
private readonly decimal meters;
public Distance(decimal meters) => this.meters = meters;
public override string ToString() =>
ToString("G", CultureInfo.CurrentCulture);
public string ToString(string? format, IFormatProvider? formatProvider)
{
formatProvider ??= CultureInfo.CurrentCulture;
return format switch
{
null or "" or "G" => meters.ToString("G", formatProvider) + " m",
"F2" => meters.ToString("F2", formatProvider) + " m",
_ => throw new FormatException("Unsupported format: " + format)
};
}
}Ergebnis
12.5 m 12.50 m
Der angezeigte Code und das angegebene Ergebnis wurden in einer isolierten Umgebung mit der im Prüfnachweis für genau diese Version dokumentierten Methode verifiziert.