Base de connaissancesCentre d’examen
FRFrançais
Choisir la langue13

CKTIS / C#

ICustomFormatter.Format — formatage personnalisé des valeurs

ICustomFormatter.Format permet à un fournisseur de format de contrôler la représentation textuelle d’une valeur sans modifier son type. La méthode fonctionne avec IFormatProvider et des méthodes comme string.Format ; une implémentation doit aussi gérer les formats ordinaires et null.

Version : .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, dans l’espace de noms System, est un rappel utilisé par le formatage personnalisé. Contrairement à IFormattable, implémentée par le type à formater, cette interface permet de définir des règles en dehors de ce type. L’API est disponible dans .NET 10 ; elle n’est ni nouvelle dans cette version ni réservée à LangVersion=preview.

Transmettez un IFormatProvider à string.Format ou à StringBuilder.AppendFormat. Le mécanisme demande un formateur avec GetFormat(typeof(ICustomFormatter)). Une même classe peut implémenter les deux interfaces et renvoyer this. Format est ensuite appelée pour chaque élément de format : pour {0:tag}, elle reçoit "tag" comme valeur de format, et arg correspond à l’argument d’index 0. Sans spécificateur, format vaut null ; formatProvider désigne le fournisseur de services de formatage.

Traitez vos combinaisons personnalisées de type et de format, puis déléguez les autres cas à IFormattable.ToString(format, provider) ou à la méthode sans paramètre ToString(). Renvoyez une chaîne vide lorsque arg == null. Un format incorrect transmis au formatage de secours peut provoquer FormatException ; un formateur personnalisé ne doit pas masquer cette erreur sans discernement.

L’exemple reconnaît "tag" uniquement pour int. Pour les autres valeurs, il utilise explicitement CultureInfo.InvariantCulture au lieu de dépendre de la culture actuelle ou du paramètre formatProvider. Ainsi, F2 produit 12.50 et null laisse les crochets vides.

Exemples

#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
        };
    }
}

Résultat

ID-0042 | 12.50 | []

Le code affiché et le résultat déclaré ont été vérifiés dans un environnement isolé selon la méthode consignée dans la preuve de vérification de cette version exacte.

Sources