KennisbankExamencentrum
NL · NLNederlands (Nederland)
Taal kiezen13

CKTIS / C#

IFormattable — waarden opmaken met een formatprovider

System.IFormattable definieert hoe een waarde wordt omgezet in tekst met een opmaakreeks en een provider voor opmaakinformatie. Zo kunnen eigen typen deelnemen aan samengestelde opmaak, zoals string.Format, in plaats van alleen te vertrouwen op parameterloze ToString().

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

Syntax

public interface IFormattable
{
    string ToString(string? format, IFormatProvider? formatProvider);
}

System.IFormattable bevat één methode: IFormattable.ToString(string? format, IFormatProvider? formatProvider). De parameter format kiest de weergave van de waarde, terwijl formatProvider opmaakinformatie levert, zoals het decimaalteken. Dit is een bibliotheekcontract dat beschikbaar is in .NET 10, geen functie waarvoor C# in preview-modus nodig is.

Een implementatie moet "G" (algemene notatie) en null als standaardnotatie ondersteunen. Het voorbeeld behandelt ook een lege tekenreeks als "G", gebruikt CultureInfo.CurrentCulture wanneer de provider null is en wijst niet-ondersteunde notaties af met FormatException. Het type bepaalt welke extra notaties beschikbaar zijn: de interface implementeren betekent niet dat alle numerieke notaties automatisch worden ondersteund.

De overload met twee parameters vervangt object.ToString() niet. In het voorbeeld delegeert een afzonderlijke override van parameterloze ToString() naar de gedeelde implementatie. string.Format geeft daaraan de notatie van een item zoals {0:F2} en de provider door. Een provider met ICustomFormatter kan de opmaak echter overnemen; de methode van het object wordt gebruikt als dat mechanisme de waarde niet verwerkt.

Het type Distance ondersteunt precies "G" en "F2", plus de standaardwaarden null en een lege tekenreeks. Het geeft de provider door bij het opmaken van de onderliggende decimal-waarde. Beide aanroepen gebruiken CultureInfo.InvariantCulture, dus de verwachte regels zijn 12.5 m en 12.50 m, ongeacht de huidige cultuur.

Voorbeelden

#nullable enable
using System;
using System.Globalization;

var distance = new Distance(12.5m);
IFormattable value = distance;
Console.WriteLine(value.ToString(null, CultureInfo.InvariantCulture));
Console.WriteLine(string.Format(CultureInfo.InvariantCulture, "{0:F2}", distance));

public sealed class Distance : IFormattable
{
    private readonly decimal meters;

    public Distance(decimal meters) => this.meters = meters;

    public override string ToString() =>
        ToString("G", CultureInfo.CurrentCulture);

    public string ToString(string? format, IFormatProvider? formatProvider)
    {
        formatProvider ??= CultureInfo.CurrentCulture;
        return format switch
        {
            null or "" or "G" => meters.ToString("G", formatProvider) + " m",
            "F2" => meters.ToString("F2", formatProvider) + " m",
            _ => throw new FormatException("Unsupported format: " + format)
        };
    }
}

Resultaat

12.5 m
12.50 m

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.

Bronnen