CKTIS / C#
ICustomFormatter.Format — vlastné formátovanie hodnôt
ICustomFormatter.Format umožňuje poskytovateľovi formátu riadiť textovú reprezentáciu hodnoty bez zmeny jej typu. Spolupracuje s IFormatProvider a metódami, ako je string.Format; implementácia by mala spracovať aj bežné formáty a null.
Verzia: .NET 10; repository net10.0 and LangVersion=preview; feature versions require per-entry verification
Syntax
string Format(string? format, object? arg, IFormatProvider? formatProvider);ICustomFormatter.Format v mennom priestore System je spätné volanie používané pri vlastnom formátovaní. Na rozdiel od IFormattable, ktorú implementuje formátovaný typ, umožňuje definovať pravidlá mimo tohto typu. API je dostupné v .NET 10; v tejto verzii nie je novinkou a nevyžaduje LangVersion=preview.
Odovzdajte IFormatProvider metóde string.Format alebo StringBuilder.AppendFormat. Mechanizmus si vyžiada formatter volaním GetFormat(typeof(ICustomFormatter)). Jedna trieda môže implementovať obe rozhrania a vracať this. Metóda Format sa potom volá pre každú položku formátu: pri {0:tag} dostane ako format hodnotu "tag" a arg je argument na indexe 0. Bez špecifikátora je format rovné null; formatProvider označuje poskytovateľa formátovacej služby.
Ošetrite vlastné kombinácie typu a formátu a ostatné prípady odovzdajte metóde IFormattable.ToString(format, provider) alebo bezparametrickej metóde ToString(). Ak arg == null, vráťte prázdny reťazec. Neplatný formát odovzdaný záložnému formátovaniu môže spôsobiť FormatException; vlastný formatter by túto chybu nemal bez uváženia skrývať.
Príklad rozpozná "tag" iba pre int. Pri ostatných hodnotách výslovne používa CultureInfo.InvariantCulture, namiesto spoliehania sa na aktuálnu kultúru alebo parameter formatProvider. Preto F2 vytvorí 12.50 a null ponechá hranaté zátvorky prázdne.
Prí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ýsledok
ID-0042 | 12.50 | []
Zobrazený kód a uvedený výsledok boli overené v izolovanom prostredí metódou zaznamenanou v dôkaze o overení tejto presnej verzie.