IFormattable.ToString(String, IFormatProvider) Método

Referência

Definição

Namespace:: System

Assembly:: System.Runtime.dll

Assembly:: mscorlib.dll

Assembly:: netstandard.dll

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Formata o valor da instância atual usando o formato especificado.

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

format: String

O formato a ser usado.

- ou - Uma referência nula (Nothing no Visual Basic) para usar o formato padrão definido para o tipo da implementação IFormattable.

formatProvider: IFormatProvider

O provedor a ser usado para formatar o valor.

- ou - Uma referência nula (Nothing no Visual Basic) para obter as informações de formato numérico da configuração de localidade atual do sistema operacional.

Retornos

String

O valor da instância atual no formato especificado.

Exemplos

O exemplo a seguir 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

Comentários

O ToString método converte um valor em uma representação de cadeia de caracteres que pode ser expressa de várias maneiras. Seu formato preciso depende de símbolos específicos ou de uma ordem especificada definida por culturas, profissões ou setores específicos. Você pode chamar o método diretamente. Ele também é chamado automaticamente pelos Convert.ToString(Object) métodos e Convert.ToString(Object, IFormatProvider) pelos métodos que usam o recurso de formatação composta no .NET Framework, como String.Format(String, Object[]), Console.WriteLine(String, Object[])e StringBuilder.AppendFormat(String, Object[]). (Para obter mais informações, consulte Formatação composta.)

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

Se o item de formato não incluir uma cadeia de caracteres de formato (por exemplo, se o item de formato for simplesmente {0}), ele será 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 caracteres de formato será passada como o valor do System.String parâmetro.
Se a chamada de método original não incluir um System.IFormatProvider parâmetro, CultureInfo.CurrentCulture será passada como o valor do System.IFormatProvider parâmetro.
Se a chamada de método original incluir um System.IFormatProvider parâmetro, o provedor fornecido na chamada de método será passado como o valor do System.IFormatProvider parâmetro.

Observação

A implementação de ToString um objeto é chamada por métodos de formatação composta somente se eles não forem passados por um ICustomFormatter provedor de formato ou se o Format método do provedor de formato personalizado retornar null.

O .NET Framework inclui três provedores de formato, todos os quais implementam a IFormatProvider interface:

NumberFormatInfo fornece informações de formatação numérica, como os caracteres a serem usados para separadores decimal e de grupo, e a ortografia e o posicionamento de símbolos de moeda em valores monetários.
DateTimeFormatInfo fornece informações de formatação relacionadas à data e hora, como a posição do mês, o dia e o ano em um padrão de data.
CultureInfo contém as informações de formatação padrão em uma cultura específica, incluindo as informações de formato numérico e informações de formatação relacionadas à data e hora.

Além disso, você pode definir seu próprio provedor de formato personalizado.

Notas aos Implementadores

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

Aplica-se a