Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / C#

IFormattable — formatowanie wartości z dostawcą formatu

System.IFormattable definiuje konwersję wartości na tekst z uwzględnieniem formatu i dostawcy informacji o formatowaniu. Pozwala własnym typom współpracować z formatowaniem złożonym, np. string.Format, zamiast polegać wyłącznie na bezparametrowym ToString().

Wersja: .NET 10; repository net10.0 and LangVersion=preview; feature versions require per-entry verification

Składnia

public interface IFormattable
{
    string ToString(string? format, IFormatProvider? formatProvider);
}

System.IFormattable zawiera jedną metodę: IFormattable.ToString(string? format, IFormatProvider? formatProvider). Parametr format wybiera reprezentację wartości, a formatProvider dostarcza informacje o formatowaniu, np. separator dziesiętny. To kontrakt biblioteki dostępny w .NET 10, nie funkcja wymagająca języka C# w wersji preview.

Implementacja musi obsługiwać "G" (format ogólny) oraz null jako format domyślny. Przykład traktuje także pusty ciąg jako "G", dla dostawcy null używa CultureInfo.CurrentCulture, a nieobsługiwany format odrzuca przez FormatException. Zestaw dodatkowych formatów określa typ: samo wdrożenie interfejsu nie zapewnia obsługi wszystkich formatów liczbowych.

Przeciążenie z dwoma parametrami nie zastępuje object.ToString(). W przykładzie osobne nadpisanie bezparametrowego ToString() deleguje do wspólnej implementacji. string.Format przekazuje do niej format z elementu takiego jak {0:F2} oraz dostawcę. Dostawca z ICustomFormatter może jednak przejąć formatowanie; metoda obiektu jest używana, gdy taki mechanizm nie obsłuży wartości.

Typ Distance obsługuje dokładnie "G" i "F2" oraz domyślne null i pusty ciąg. Przekazuje dostawcę do formatowania wewnętrznej wartości decimal. Oba wywołania używają CultureInfo.InvariantCulture, więc oczekiwane linie to 12.5 m i 12.50 m, niezależnie od bieżącej kultury.

Przykłady

#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)
        };
    }
}

Wynik

12.5 m
12.50 m

Wyświetlony kod i zadeklarowany wynik zweryfikowano w odizolowanym środowisku metodą zapisaną w dowodzie weryfikacji tej dokładnej wersji.

Źródła