CKTIS / C#
IFormattable: dar formato a valores con un proveedor de formato
System.IFormattable define la conversión de un valor a texto mediante una cadena de formato y un proveedor de información de formato. Permite que los tipos personalizados participen en el formato compuesto, como string.Format, en lugar de depender únicamente de ToString() sin parámetros.
Versión: .NET 10; repository net10.0 and LangVersion=preview; feature versions require per-entry verification
Sintaxis
public interface IFormattable
{
string ToString(string? format, IFormatProvider? formatProvider);
}System.IFormattable contiene un método: IFormattable.ToString(string? format, IFormatProvider? formatProvider). El parámetro format selecciona la representación del valor, mientras que formatProvider proporciona información de formato, como el separador decimal. Se trata de un contrato de biblioteca disponible en .NET 10, no de una característica que requiera C# en versión preview.
Una implementación debe admitir "G" (formato general) y null como formato predeterminado. El ejemplo también trata una cadena vacía como "G", usa CultureInfo.CurrentCulture cuando el proveedor es null y rechaza los formatos no admitidos con FormatException. El tipo determina los formatos adicionales: implementar la interfaz no proporciona automáticamente compatibilidad con todos los formatos numéricos.
La sobrecarga de dos parámetros no reemplaza a object.ToString(). En el ejemplo, una sobrescritura independiente de ToString() sin parámetros delega en la implementación común. string.Format le pasa el formato de un elemento como {0:F2} y el proveedor. Sin embargo, un proveedor con ICustomFormatter puede encargarse del formato; se usa el método del objeto cuando ese mecanismo no procesa el valor.
El tipo Distance admite exactamente "G" y "F2", además de los valores predeterminados null y cadena vacía. Pasa el proveedor al dar formato a su valor decimal subyacente. Ambas llamadas usan CultureInfo.InvariantCulture, por lo que las líneas esperadas son 12.5 m y 12.50 m, independientemente de la cultura actual.
Ejemplos
#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)
};
}
}Resultado
12.5 m 12.50 m
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.