IFormattable.ToString(String, IFormatProvider) Método

Definição

Formata o valor da instância atual usando o formato especificado.Formats the value of the current instance using the specified format.

public:
 System::String ^ ToString(System::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.The format to use.

- ou --or- Uma referência nula (Nothing no Visual Basic) para usar o formato padrão definido para o tipo da implementação IFormattable.A null reference (Nothing in Visual Basic) to use the default format defined for the type of the IFormattable implementation.

formatProvider
IFormatProvider

O provedor a ser usado para formatar o valor.The provider to use to format the value.

- ou --or- 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.A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.

Retornos

O valor da instância atual no formato especificado.The value of the current instance in the specified format.

Exemplos

O exemplo a seguir demonstra Temperature uma classe que implementa ToString o método.The following example demonstrates a Temperature class that implements the ToString method. Este exemplo de código faz parte de um exemplo maior fornecido para IFormattable a classe.This code example is part of a larger example provided for the IFormattable class.

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));
      }
   }
}
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.The ToString method converts a value to a string representation that can be expressed in multiple ways. Seu formato preciso depende de símbolos específicos ou de uma ordem especificada definida por culturas, profissão ou setores específicos.Its precise format depends on specific symbols or a specified order defined by specific cultures, professions, or industries. Você pode chamar o método diretamente.You can call the method directly. Ele também é chamado automaticamente pelos Convert.ToString(Object) métodos e Convert.ToString(Object, IFormatProvider) , e por 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[]).It is also called automatically by the Convert.ToString(Object) and Convert.ToString(Object, IFormatProvider) methods, and by methods that use the composite formatting feature in the .NET Framework, such as String.Format(String, Object[]), Console.WriteLine(String, Object[]), and StringBuilder.AppendFormat(String, Object[]). (Para obter mais informações, consulte formatação composta.)(For more information, see Composite Formatting.)

Os métodos de formatação composta ToString chamam o método uma vez para cada item de formato em uma cadeia de caracteres de formato.Composite formatting methods call the ToString method once for each format item in a format string. Os parâmetros passados para o método dependem do método de formatação específico chamado e do conteúdo do item de formato, da seguinte maneira:The parameters passed to the method depend on the specific formatting method that is called and on the content of the format item, as follows:

Observação

A implementação de ToString um objeto será chamada por métodos de formatação compostos somente se eles não passarem por um ICustomFormatter provedor de formato Format ou se o método do provedor de nullformato personalizado retornar.An object's ToString implementation is called by composite formatting methods only if they are not passed an ICustomFormatter format provider, or if the Format method of the custom format provider returns null.

O .NET Framework inclui três provedores de formato, todos os quais implementam a IFormatProvider interface:The .NET Framework includes three format providers, all of which implement the IFormatProvider interface:

  • NumberFormatInfofornece informações de formatação numérica, como os caracteres a serem usados para separadores de decimal e de grupo, e a ortografia e o posicionamento de símbolos de moeda em valores monetários.NumberFormatInfo supplies numeric formatting information, such as the characters to use for decimal and group separators, and the spelling and placement of currency symbols in monetary values.

  • DateTimeFormatInfofornece 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.DateTimeFormatInfo supplies date-related and time-related formatting information, such as the position of the month, the day, and the year in a date pattern.

  • CultureInfoconté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.CultureInfo contains the default formatting information in a specific culture, including the numeric format information, and date-related and time-related formatting information.

Além disso, você pode definir seu próprio provedor de formato personalizado.In addition, you can define your own custom format provider.

Notas aos Implementadores

O ToString(String, IFormatProvider) método deve oferecer suporte ao especificador de formato "G" (geral).The ToString(String, IFormatProvider) method must support the "G" (general) format specifier. Além do especificador "G", a classe pode definir a lista de especificadores de formato com suporte.Besides the "G" specifier, the class can define the list of format specifiers that it supports. Além disso, a classe deve estar preparada para manipular um especificador de formato nullque é.In addition, the class must be prepared to handle a format specifier that is null. Para obter mais informações sobre códigos de formatação e formatação, consulte tipos de formatação.For more information about formatting and formatting codes, see Formatting Types.

Aplica-se a

Veja também