CKTIS / C#
ICustomFormatter.Format — vlastní formátování hodnot
ICustomFormatter.Format umožňuje poskytovateli formátu řídit textovou reprezentaci hodnoty, aniž by měnil její typ. Spolupracuje s IFormatProvider a metodami, jako je string.Format; implementace by měla zpracovat také běžné formáty a null.
Verze: .NET 10; repository net10.0 and LangVersion=preview; feature versions require per-entry verification
Syntaxe
string Format(string? format, object? arg, IFormatProvider? formatProvider);ICustomFormatter.Format v oboru názvů System je zpětné volání používané při vlastním formátování. Na rozdíl od IFormattable, kterou implementuje formátovaný typ, umožňuje definovat pravidla mimo tento typ. API je dostupné v .NET 10; v této verzi není novinkou a nevyžaduje LangVersion=preview.
Předejte IFormatProvider metodě string.Format nebo StringBuilder.AppendFormat. Mechanismus si vyžádá formatter voláním GetFormat(typeof(ICustomFormatter)). Jedna třída může implementovat obě rozhraní a vracet this. Metoda Format se pak volá pro každou položku formátu: pro {0:tag} obdrží jako format hodnotu "tag" a arg je argument na indexu 0. Bez specifikátoru je format rovno null; formatProvider označuje poskytovatele formátovací služby.
Ošetřete vlastní kombinace typu a formátu a ostatní případy předejte metodě IFormattable.ToString(format, provider) nebo bezparametrické metodě ToString(). Pokud arg == null, vraťte prázdný řetězec. Neplatný formát předaný záložnímu formátování může způsobit FormatException; vlastní formatter by tuto chybu neměl bez rozmyslu skrývat.
Příklad rozpozná "tag" pouze pro int. U ostatních hodnot výslovně používá CultureInfo.InvariantCulture, místo aby se spoléhal na aktuální kulturu nebo parametr formatProvider. Proto F2 vytvoří 12.50 a null ponechá hranaté závorky prázdné.
Příklady
#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
};
}
}
Výsledek
ID-0042 | 12.50 | []
Zobrazený kód a uvedený výsledek byly ověřeny v izolovaném prostředí metodou zaznamenanou v dokladu o ověření této přesné verze.