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

CKTIS / C#

Formato personalizado en .NET: proveedor, formateador y tipo

Distingue tres contratos de formato: localizar un servicio, interceptar un elemento y dejar que el propio tipo del valor genere el texto.

Versión: C# 12 and .NET 8; later runtimes may add compatible features

Sintaxis

C# 12 / .NET 8, namespace System
IFormatProvider: object? GetFormat(Type? formatType);
ICustomFormatter: string Format(string? format, object? arg, IFormatProvider? formatProvider);
IFormattable: string ToString(string? format, IFormatProvider? formatProvider);
Composite formatting: string.Format(provider, "{0:code}", value)
Direct call: ((IFormattable)value).ToString("G", provider)

En C# 12 y .NET 8, las tres interfaces pertenecen a System. La sobrecarga de string.Format que acepta un proveedor llama a IFormatProvider.GetFormat(Type?) con typeof(ICustomFormatter), no con el tipo del valor que se va a formatear. El proveedor devuelve un servicio del tipo solicitado o null. Puede devolver this si implementa el servicio. El formateador encontrado se reutiliza durante esa llamada.

Para {0:F2}, ICustomFormatter.Format recibe "F2", el argumento de índice cero y el proveedor. En {0} no hay código de formato, por lo que recibe null. Cualquier cadena devuelta, incluso "", da por tratado el elemento. Si devuelve null, esta sobrecarga de string.Format continúa con el formato ordinario. El ! en null! solo suprime una advertencia de nulabilidad: el método devuelve null aunque su tipo de retorno sea string.

Si no hay formateador personalizado o este no procesa el elemento, en .NET 8 string.Format puede intentar primero usar ISpanFormattable.TryFormat. Si se omite ese paso o TryFormat devuelve false, un argumento no nulo que implemente IFormattable se formatea mediante IFormattable.ToString(format, provider). Para los demás argumentos no nulos, se usa ToString() sin parámetros y sin pasarle el código de formato. Si un argumento null llega al formato ordinario, se trata como una cadena vacía antes de añadir los espacios que requiera la alineación. Implementa "G" y null como formato general. Un tipo puede lanzar FormatException por un código no admitido; string.Format puede lanzar la misma excepción de forma independiente, por ejemplo, por un índice fuera de la lista de argumentos.

Una llamada directa a ToString con dos argumentos no invoca automáticamente ICustomFormatter. El tipo aún puede usar el proveedor, por ejemplo para obtener NumberFormatInfo o DateTimeFormatInfo mediante GetFormat. Evita volver a llamar a string.Format dentro de Format con el mismo proveedor, argumento y código: podrías volver a entrar en el mismo formateador.

Ejemplos

#nullable enable
using System;
using System.Globalization;

var provider = new ReadingFormatProvider();
var reading = new Voltage(12.5m);
Console.WriteLine(string.Format(provider, "{0:bracket} | {0:F2} | {0}", reading));

sealed class ReadingFormatProvider : IFormatProvider, ICustomFormatter
{
    public object? GetFormat(Type? formatType) =>
        formatType == typeof(ICustomFormatter)
            ? this
            : CultureInfo.InvariantCulture.GetFormat(formatType);

    public string Format(string? format, object? arg, IFormatProvider? formatProvider)
    {
        if (format == "bracket" && arg is Voltage voltage)
            return "[" + voltage.ToString("F2", formatProvider) + "]";

        return null!; // string.Format continues with ordinary formatting.
    }
}

sealed class Voltage(decimal volts) : IFormattable
{
    public override string ToString() => ToString("G", null);

    public string ToString(string? format, IFormatProvider? formatProvider) =>
        (format switch
        {
            null or "G" => volts.ToString("G", formatProvider),
            "F2" => volts.ToString("F2", formatProvider),
            _ => throw new FormatException($"Unsupported voltage format: {format}")
        }) + " V";
}

Resultado

[12.50 V] | 12.50 V | 12.5 V

El formateador procesa `bracket` para `Voltage`: llama directamente a `ToString("F2", formatProvider)` y añade corchetes. Los otros dos elementos se resuelven mediante `Voltage.ToString`. El proveedor delega las solicitudes de datos culturales en `CultureInfo.InvariantCulture`, por lo que el separador decimal es un punto.

Lecciones relacionadas

  • C# · Lección 33 · Avanzado · Versión: 3

Fuentes