Base de conocimientosCentro de exámenes
ESEspañol
Elegir idioma13

CKTIS / C#

ICustomFormatter.Format — formato personalizado de valores

ICustomFormatter.Format permite que un proveedor de formato controle la representación textual de un valor sin cambiar su tipo. Funciona con IFormatProvider y métodos como string.Format; una implementación también debe gestionar los formatos habituales y null.

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

Sintaxis

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

ICustomFormatter.Format, del espacio de nombres System, es una devolución de llamada que se usa en el formato personalizado. A diferencia de IFormattable, que implementa el tipo que se va a formatear, permite definir reglas fuera de ese tipo. La API está disponible en .NET 10; no es nueva en esa versión ni requiere LangVersion=preview.

Pasa un IFormatProvider a string.Format o a StringBuilder.AppendFormat. El mecanismo solicita un formateador mediante GetFormat(typeof(ICustomFormatter)). Una clase puede implementar ambas interfaces y devolver this. Después se llama a Format para cada elemento de formato: en {0:tag}, recibe "tag" como format, y arg es el argumento del índice 0. Si no hay especificador, format es null; formatProvider identifica al proveedor del servicio de formato.

Gestiona tus combinaciones personalizadas de tipo y formato y delega los demás casos en IFormattable.ToString(format, provider) o en ToString() sin parámetros. Devuelve una cadena vacía cuando arg == null. Un formato no válido que se pase al formato de reserva puede provocar FormatException; un formateador personalizado no debería ocultar ese error sin más.

El ejemplo reconoce "tag" solo para int. Para los demás valores, usa explícitamente CultureInfo.InvariantCulture, en lugar de depender de la cultura actual o del parámetro formatProvider. Por eso, F2 produce 12.50 y null deja los corchetes vacíos.

Ejemplos

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

Resultado

ID-0042 | 12.50 | []

El código mostrado y el resultado declarado se verificaron en un entorno aislado mediante el método registrado en la evidencia de verificación de esta versión exacta.

Fuentes