Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / C#

ICustomFormatter.Format — własne formatowanie wartości

ICustomFormatter.Format pozwala dostawcy formatowania określić tekstową reprezentację wartości bez zmieniania jej typu. Współpracuje z IFormatProvider oraz metodami takimi jak string.Format; implementacja powinna także obsługiwać zwykłe formaty i null.

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

Składnia

string Format(string? format, object? arg, IFormatProvider? formatProvider);

ICustomFormatter.Format z przestrzeni System jest metodą wywoływaną zwrotnie przez mechanizm własnego formatowania. W przeciwieństwie do IFormattable, implementowanego przez formatowany typ, pozwala określić reguły poza tym typem. API jest dostępne w .NET 10; nie jest nowością tej wersji ani funkcją wymagającą LangVersion=preview.

Przekaż IFormatProvider do string.Format lub StringBuilder.AppendFormat. Mechanizm pyta GetFormat(typeof(ICustomFormatter)) o formatter. Jedna klasa może implementować oba interfejsy i zwracać this. Format jest następnie wywoływana dla każdego elementu formatującego: w {0:tag} otrzymuje format równy "tag", a arg jest argumentem o indeksie 0. Bez specyfikatora format ma wartość null; formatProvider wskazuje dostawcę usług formatowania.

Obsłuż własne kombinacje typu i formatu, a pozostałe deleguj do IFormattable.ToString(format, provider) lub bezparametrowej ToString(). Dla arg == null zwróć pusty tekst. Niepoprawny format przekazany dalej może spowodować FormatException; własny formatter nie powinien bezmyślnie ukrywać tego błędu.

Przykład rozpoznaje "tag" tylko dla int. Dla pozostałych wartości jawnie stosuje CultureInfo.InvariantCulture, zamiast polegać na bieżącej kulturze lub parametrze formatProvider. Dzięki temu F2 daje 12.50, a null pozostawia puste nawiasy.

Przykłady

#nullable enable
using System;
using System.Globalization;

Console.WriteLine(string.Format(new LabelFormatter(),
    "{0:tag} | {1:F2} | [{2}]", 42, 12.5m, (object?)null));

sealed class LabelFormatter : IFormatProvider, ICustomFormatter
{
    public object? GetFormat(Type? formatType) =>
        formatType == typeof(ICustomFormatter) ? this : null;

    public string Format(string? format, object? arg,
        IFormatProvider? formatProvider)
    {
        if (format == "tag" && arg is int number)
            return "ID-" + number.ToString("D4", CultureInfo.InvariantCulture);

        return arg switch
        {
            null => string.Empty,
            IFormattable formattable =>
                formattable.ToString(format, CultureInfo.InvariantCulture) ?? string.Empty,
            _ => arg.ToString() ?? string.Empty
        };
    }
}

Wynik

ID-0042 | 12.50 | []

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

Źródła