CKTIS / C#
IFormattable — formatar valores com um fornecedor de formato
System.IFormattable define a conversão de um valor em texto através de uma cadeia de formato e de um fornecedor de informações de formatação. Permite que tipos personalizados participem na formatação composta, como string.Format, em vez de dependerem apenas de ToString() sem parâmetros.
Versão: .NET 10; repository net10.0 and LangVersion=preview; feature versions require per-entry verification
Sintaxe
public interface IFormattable
{
string ToString(string? format, IFormatProvider? formatProvider);
}System.IFormattable contém um método: IFormattable.ToString(string? format, IFormatProvider? formatProvider). O parâmetro format seleciona a representação do valor, enquanto formatProvider fornece informações de formatação, como o separador decimal. Trata-se de um contrato da biblioteca disponível no .NET 10, não de uma funcionalidade que exija C# em versão preview.
Uma implementação tem de suportar "G" (formato geral) e null como formato predefinido. O exemplo também trata uma cadeia vazia como "G", utiliza CultureInfo.CurrentCulture quando o fornecedor é null e rejeita formatos não suportados com FormatException. O tipo define os formatos adicionais: implementar a interface não garante automaticamente o suporte de todos os formatos numéricos.
A sobrecarga com dois parâmetros não substitui object.ToString(). No exemplo, uma substituição separada de ToString() sem parâmetros delega na implementação comum. string.Format passa-lhe o formato de um elemento como {0:F2} e o fornecedor. No entanto, um fornecedor com ICustomFormatter pode assumir a formatação; o método do objeto é utilizado quando esse mecanismo não processa o valor.
O tipo Distance suporta exatamente "G" e "F2", além dos valores predefinidos null e cadeia vazia. Passa o fornecedor ao formatar o valor decimal subjacente. Ambas as chamadas utilizam CultureInfo.InvariantCulture, pelo que as linhas esperadas são 12.5 m e 12.50 m, independentemente da cultura atual.
Exemplos
#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
O código apresentado e o resultado declarado foram verificados num ambiente isolado pelo método registado na prova de verificação desta versão exata.