Base di conoscenzaCentro esami
ITItaliano
Scegli la lingua13

CKTIS / C#

ICustomFormatter.Format — formattazione personalizzata dei valori

ICustomFormatter.Format consente a un provider di formattazione di controllare la rappresentazione testuale di un valore senza modificarne il tipo. Funziona con IFormatProvider e metodi come string.Format; un’implementazione dovrebbe gestire anche i formati ordinari e null.

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

Sintassi

string Format(string? format, object? arg, IFormatProvider? formatProvider);

ICustomFormatter.Format, nello spazio dei nomi System, è un callback usato per la formattazione personalizzata. A differenza di IFormattable, implementata dal tipo da formattare, consente di definire regole esterne a quel tipo. L’API è disponibile in .NET 10; non è una novità di questa versione né una funzionalità che richiede LangVersion=preview.

Passa un IFormatProvider a string.Format o a StringBuilder.AppendFormat. Il meccanismo richiede un formatter tramite GetFormat(typeof(ICustomFormatter)). Una classe può implementare entrambe le interfacce e restituire this. Format viene quindi chiamato per ogni elemento di formato: per {0:tag}, riceve "tag" come format, mentre arg è l’argomento all’indice 0. Senza specificatore, format è null; formatProvider identifica il provider del servizio di formattazione.

Gestisci le combinazioni personalizzate di tipo e formato, quindi delega gli altri casi a IFormattable.ToString(format, provider) o a ToString() senza parametri. Restituisci una stringa vuota se arg == null. Un formato non valido passato alla formattazione di fallback può causare FormatException; un formatter personalizzato non dovrebbe nascondere l’errore senza criterio.

L’esempio riconosce "tag" solo per int. Per gli altri valori usa esplicitamente CultureInfo.InvariantCulture, invece di affidarsi alla cultura corrente o al parametro formatProvider. Di conseguenza, F2 produce 12.50 e null lascia le parentesi quadre vuote.

Esempi

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

Risultato

ID-0042 | 12.50 | []

Il codice mostrato e il risultato dichiarato sono stati verificati in un ambiente isolato con il metodo registrato nella prova di verifica di questa versione esatta.

Fonti