IFormattable.ToString(String, IFormatProvider) Método

public:
 System::String ^ ToString(System::String ^ format, IFormatProvider ^ formatProvider);

public string ToString(string format, IFormatProvider formatProvider);

public string ToString(string? format, IFormatProvider? formatProvider);

abstract member ToString : string * IFormatProvider -> string

Public Function ToString (format As String, formatProvider As IFormatProvider) As String

Parâmetros

Devoluções

O valor da instância atual no formato especificado.

Exemplos

O exemplo seguinte demonstra uma Temperature classe que implementa o ToString método. Este exemplo de código faz parte de um exemplo maior fornecido para a IFormattable classe.

using System;
using System.Globalization;

public class Temperature : IFormattable
{
   private decimal temp;

   public Temperature(decimal temperature)
   {
      if (temperature < -273.15m)
        throw new ArgumentOutOfRangeException(String.Format("{0} is less than absolute zero.",
                                              temperature));
      this.temp = temperature;
   }

   public decimal Celsius
   {
      get { return temp; }
   }

   public decimal Fahrenheit
   {
      get { return temp * 9 / 5 + 32; }
   }

   public decimal Kelvin
   {
      get { return temp + 273.15m; }
   }

   public override string ToString()
   {
      return this.ToString("G", CultureInfo.CurrentCulture);
   }

   public string ToString(string format)
   {
      return this.ToString(format, CultureInfo.CurrentCulture);
   }

   public string ToString(string format, IFormatProvider provider)
   {
      if (String.IsNullOrEmpty(format)) format = "G";
      if (provider == null) provider = CultureInfo.CurrentCulture;

      switch (format.ToUpperInvariant())
      {
         case "G":
         case "C":
            return temp.ToString("F2", provider) + " °C";
         case "F":
            return Fahrenheit.ToString("F2", provider) + " °F";
         case "K":
            return Kelvin.ToString("F2", provider) + " K";
         default:
            throw new FormatException(String.Format("The {0} format string is not supported.", format));
      }
   }
}

open System
open System.Globalization

type Temperature(temperature: decimal) =
    do 
        if temperature < -273.15M then
            raise (ArgumentOutOfRangeException $"{temperature} is less than absolute zero.")

    member _.Celsius =
        temperature

    member _.Fahrenheit =
        temperature * 9M / 5M + 32M

    member _.Kelvin =
        temperature + 273.15m

    override this.ToString() =
        this.ToString("G", CultureInfo.CurrentCulture)

    member this.ToString(format) =
        this.ToString(format, CultureInfo.CurrentCulture)

    member this.ToString(format, provider: IFormatProvider) =
        let format =
            if String.IsNullOrEmpty format then "G"
            else format

        let provider =
            if isNull provider then 
                CultureInfo.CurrentCulture :> IFormatProvider
            else provider

        match format.ToUpperInvariant() with
        | "G" | "C" ->
            temperature.ToString("F2", provider) + " °C"
        | "F" ->
            this.Fahrenheit.ToString("F2", provider) + " °F"
        | "K" ->
            this.Kelvin.ToString("F2", provider) + " K"
        | _ ->
            raise (FormatException $"The {format} format string is not supported.")

    interface IFormattable with
        member this.ToString(format, provider) = this.ToString(format, provider)

Imports System.Globalization

Public Class Temperature : Implements IFormattable
   Private temp As Decimal
   
   Public Sub New(temperature As Decimal)
      If temperature < -273.15 Then _ 
        Throw New ArgumentOutOfRangeException(String.Format("{0} is less than absolute zero.", _
                                              temperature))
      Me.temp = temperature
   End Sub
   
   Public ReadOnly Property Celsius As Decimal
      Get
         Return temp
      End Get
   End Property
   
   Public ReadOnly Property Fahrenheit As Decimal
      Get
         Return temp * 9 / 5 + 32
      End Get
   End Property
   
   Public ReadOnly Property Kelvin As Decimal
      Get
         Return temp + 273.15d
      End Get
   End Property

   Public Overrides Function ToString() As String
      Return Me.ToString("G", CultureInfo.CurrentCulture)
   End Function
      
   Public Overloads Function ToString(fmt As String) As String
      Return Me.ToString(fmt, CultureInfo.CurrentCulture)
   End Function
   
   Public Overloads Function ToString(fmt As String, provider As IFormatProvider) _
                   As String _
                   Implements IFormattable.ToString
      If String.IsNullOrEmpty(fmt) Then fmt = "G"
      If provider Is Nothing Then provider = CultureInfo.CurrentCulture
      
      Select Case fmt.ToUpperInvariant()
         Case "G", "C"
            Return temp.ToString("F2", provider) + " °C" 
         Case "F"
            Return Fahrenheit.ToString("F2", provider) + " °F"
         Case "K"
            Return Kelvin.ToString("F2", provider) + " K"
         Case Else
            Throw New FormatException(String.Format("The {0} format string is not supported.", fmt))
      End Select
   End Function
End Class

Observações

O ToString método converte um valor numa representação de cadeia que pode ser expressa de várias formas. O seu formato preciso depende de símbolos específicos ou de uma ordem definida por culturas, profissões ou indústrias específicas. Pode contactar diretamente o método. Também é chamada automaticamente pelos métodos Convert.ToString(Object) e Convert.ToString(Object, IFormatProvider), e por métodos que utilizam a funcionalidade de formatação composta no .NET Framework, como String.Format(String, Object[]), Console.WriteLine(String, Object[]) e StringBuilder.AppendFormat(String, Object[]). (Para mais informações, veja Formatação Composta.)

Os métodos de formatação composta chamam o ToString método uma vez para cada item de formato numa cadeia de formato. Os parâmetros passados ao método dependem do método de formatação específico que é chamado e do conteúdo do item do formato, da seguinte forma:

• Se o item de formato não incluir uma string de formato (por exemplo, se o item de formato for simplesmente {0}), é passado null como o valor do System.String parâmetro.

• Se o item de formato incluir uma cadeia de caracteres de formato (por exemplo, {0:G}), essa cadeia de formato é passada como valor do System.String parâmetro.

• Se a chamada original ao método não incluir um System.IFormatProvider parâmetro, CultureInfo.CurrentCulture é passada como o valor do System.IFormatProvider parâmetro.

• Se a chamada original ao método incluir um System.IFormatProvider parâmetro, o fornecedor fornecido na chamada ao método é passado como o valor do System.IFormatProvider parâmetro.

O .NET Framework inclui três fornecedores de formato, todos eles implementando a interface IFormatProvider:

• NumberFormatInfo fornece informações de formatação numérica, como os caracteres a usar para separadores decimais e de grupo, bem como a ortografia e colocação dos símbolos de moeda em valores monetários.

• DateTimeFormatInfo fornece informações de formatação relacionadas com datas e horas, como a posição do mês, o dia e o ano, num padrão de data.

• CultureInfo contém a informação de formatação padrão numa cultura específica, incluindo a informação de formato numérico, e informação de formatação relacionada com data e hora.

Além disso, pode definir o seu próprio fornecedor de formatos personalizado.

Notas para Implementadores

O ToString(String, IFormatProvider) método deve suportar o especificador de formato "G" (geral). Além do especificador "G", a classe pode definir a lista de especificadores de formato que suporta. Além disso, a classe deve estar preparada para lidar com um especificador de formato que seja null. Para mais informações sobre formatação e códigos de formatação, consulte Tipos de Formatação.

Ver também

• String
• IFormatProvider
• NumberFormatInfo
• DateTimeFormatInfo
• CultureInfo