CKTIS / C#
ICustomFormatter.Format — aangepaste waardeopmaak
ICustomFormatter.Format laat een opmaakprovider de tekstweergave van een waarde bepalen zonder het type ervan te wijzigen. De methode werkt met IFormatProvider en methoden zoals string.Format; een implementatie moet ook gewone opmaak en null afhandelen.
Versie: .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 in de naamruimte System is een callback die wordt gebruikt voor aangepaste opmaak. Anders dan IFormattable, dat door het op te maken type wordt geïmplementeerd, kunt u hiermee regels buiten dat type definiëren. De API is beschikbaar in .NET 10; ze is niet nieuw in die versie en vereist geen LangVersion=preview.
Geef een IFormatProvider door aan string.Format of StringBuilder.AppendFormat. Het mechanisme vraagt met GetFormat(typeof(ICustomFormatter)) om een formatter. Eén klasse kan beide interfaces implementeren en this teruggeven. Daarna wordt Format aangeroepen voor elk opmaakitem: bij {0:tag} ontvangt de methode "tag" als format, en arg is het argument op index 0. Zonder specificatie is format gelijk aan null; formatProvider verwijst naar de provider van de opmaakservice.
Verwerk uw aangepaste combinaties van type en opmaak en delegeer de overige gevallen aan IFormattable.ToString(format, provider) of de parameterloze methode ToString(). Geef een lege tekenreeks terug als arg == null. Een ongeldige opmaak die aan de terugvalopmaak wordt doorgegeven, kan FormatException veroorzaken; een aangepaste formatter hoort die fout niet zonder meer te verbergen.
Het voorbeeld herkent "tag" alleen voor int. Voor andere waarden gebruikt het expliciet CultureInfo.InvariantCulture in plaats van te vertrouwen op de huidige cultuur of de parameter formatProvider. Daardoor levert F2 12.50 op en laat null lege haken achter.
Voorbeelden
#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
};
}
}
Resultaat
ID-0042 | 12.50 | []
De getoonde code en het opgegeven resultaat zijn in een geïsoleerde omgeving geverifieerd met de methode die in het verificatiebewijs voor exact deze versie is vastgelegd.