Base di conoscenzaCentro esami
ITItaliano
Scegli la lingua13

CKTIS / C#

IFormattable — formattare i valori con un provider di formato

System.IFormattable definisce la conversione di un valore in testo usando una stringa di formato e un provider di informazioni di formattazione. Consente ai tipi personalizzati di partecipare alla formattazione composita, come string.Format, invece di affidarsi solo a ToString() senza parametri.

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

Sintassi

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

System.IFormattable contiene un metodo: IFormattable.ToString(string? format, IFormatProvider? formatProvider). Il parametro format seleziona la rappresentazione del valore, mentre formatProvider fornisce informazioni di formattazione, ad esempio il separatore decimale. È un contratto della libreria disponibile in .NET 10, non una funzionalità che richiede C# in versione preview.

Un’implementazione deve supportare "G" (formato generale) e null come formato predefinito. L’esempio tratta anche una stringa vuota come "G", usa CultureInfo.CurrentCulture quando il provider è null e rifiuta i formati non supportati con FormatException. È il tipo a definire i formati aggiuntivi: implementare l’interfaccia non comporta il supporto automatico di tutti i formati numerici.

L’overload con due parametri non sostituisce object.ToString(). Nell’esempio, un override separato di ToString() senza parametri delega all’implementazione condivisa. string.Format le passa il formato di un elemento come {0:F2} e il provider. Tuttavia, un provider con ICustomFormatter può gestire la formattazione; il metodo dell’oggetto viene usato quando quel meccanismo non gestisce il valore.

Il tipo Distance supporta esattamente "G" e "F2", oltre ai valori predefiniti null e stringa vuota. Passa il provider quando formatta il valore decimal sottostante. Entrambe le chiamate usano CultureInfo.InvariantCulture, quindi le righe previste sono 12.5 m e 12.50 m, a prescindere dalla cultura corrente.

Esempi

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

Risultato

12.5 m
12.50 m

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