KennisbankExamencentrum
NL · NLNederlands (Nederland)
Taal kiezen13

CKTIS / C#

Aangepaste opmaak in .NET: provider, formatter en type

Onderscheid drie opmaakcontracten: een dienst opzoeken, een opmaakitem afvangen en het type van de waarde zelf de tekst laten produceren.

Versie: C# 12 and .NET 8; later runtimes may add compatible features

Syntax

C# 12 / .NET 8, namespace System
IFormatProvider: object? GetFormat(Type? formatType);
ICustomFormatter: string Format(string? format, object? arg, IFormatProvider? formatProvider);
IFormattable: string ToString(string? format, IFormatProvider? formatProvider);
Composite formatting: string.Format(provider, "{0:code}", value)
Direct call: ((IFormattable)value).ToString("G", provider)

In C# 12 en .NET 8 staan alle drie de interfaces in System. De overload van string.Format die een provider accepteert, roept IFormatProvider.GetFormat(Type?) aan met typeof(ICustomFormatter), niet met het type van de op te maken waarde. De provider retourneert een dienst van het gevraagde type of null. Hij kan this retourneren als hij de dienst zelf implementeert. De gevonden formatter wordt binnen die aanroep hergebruikt.

Voor {0:F2} ontvangt ICustomFormatter.Format "F2", het argument op index nul en de provider. In {0} ontbreekt de opmaakcode, dus ontvangt de methode null. Elke geretourneerde tekenreeks, ook "", rondt de verwerking van het item af. Bij null gaat deze overload van string.Format verder met de gewone opmaak. De ! in null! onderdrukt alleen een waarschuwing over nullwaarden: de methode retourneert nog steeds null, hoewel het retourtype string is.

Als er geen aangepaste formatter is of die het item niet verwerkt, kan string.Format in .NET 8 eerst ISpanFormattable.TryFormat proberen. Als deze stap wordt overgeslagen of TryFormat false retourneert, wordt een argument dat niet null is en IFormattable implementeert, opgemaakt met IFormattable.ToString(format, provider). Voor andere argumenten die niet null zijn, wordt het parameterloze ToString() gebruikt, zonder opmaakcode. Een null-argument dat de gewone opmaak bereikt, wordt als lege tekenreeks behandeld voordat eventuele spaties voor uitlijning worden toegevoegd. Implementeer "G" en null als algemene opmaak. Een type kan FormatException genereren bij een niet-ondersteunde code; string.Format kan diezelfde uitzondering onafhankelijk daarvan genereren, bijvoorbeeld bij een index buiten de argumentenlijst.

Een directe aanroep van ToString met twee argumenten roept niet automatisch ICustomFormatter aan. Het type kan de provider wel gebruiken om bijvoorbeeld NumberFormatInfo of DateTimeFormatInfo op te vragen met GetFormat. Roep binnen Format niet opnieuw string.Format aan met dezelfde provider, hetzelfde argument en dezelfde code: dat kan dezelfde formatter opnieuw aanroepen.

Voorbeelden

#nullable enable
using System;
using System.Globalization;

var provider = new ReadingFormatProvider();
var reading = new Voltage(12.5m);
Console.WriteLine(string.Format(provider, "{0:bracket} | {0:F2} | {0}", reading));

sealed class ReadingFormatProvider : IFormatProvider, ICustomFormatter
{
    public object? GetFormat(Type? formatType) =>
        formatType == typeof(ICustomFormatter)
            ? this
            : CultureInfo.InvariantCulture.GetFormat(formatType);

    public string Format(string? format, object? arg, IFormatProvider? formatProvider)
    {
        if (format == "bracket" && arg is Voltage voltage)
            return "[" + voltage.ToString("F2", formatProvider) + "]";

        return null!; // string.Format continues with ordinary formatting.
    }
}

sealed class Voltage(decimal volts) : IFormattable
{
    public override string ToString() => ToString("G", null);

    public string ToString(string? format, IFormatProvider? formatProvider) =>
        (format switch
        {
            null or "G" => volts.ToString("G", formatProvider),
            "F2" => volts.ToString("F2", formatProvider),
            _ => throw new FormatException($"Unsupported voltage format: {format}")
        }) + " V";
}

Resultaat

[12.50 V] | 12.50 V | 12.5 V

De formatter verwerkt `bracket` voor `Voltage` door rechtstreeks `ToString("F2", formatProvider)` aan te roepen en vierkante haken toe te voegen. De andere twee items vallen terug op `Voltage.ToString`. De provider delegeert aanvragen voor cultuurgegevens aan `CultureInfo.InvariantCulture`, zodat het decimaalteken een punt is.

Gerelateerde lessen

  • C# · Les 33 · Gevorderd · Versie: 3

Bronnen