IFormattable Interface

Definição

Fornece funcionalidade para formatar o valor de um objeto em uma representação de cadeia de caracteres.Provides functionality to format the value of an object into a string representation.

public interface class IFormattable
[System.Runtime.InteropServices.ComVisible(true)]
public interface IFormattable
type IFormattable = interface
Public Interface IFormattable
Derivado
Atributos

Exemplos

O exemplo a seguir define uma classe Temperature que implementa a interface IFormattable.The following example defines a Temperature class that implements the IFormattable interface. A classe dá suporte a quatro especificadores de formato: "G" e "C", que indicam que a temperatura deve ser exibida em Celsius; "F", que indica que a temperatura deve ser exibida em Fahrenheit; e "K", que indica que a temperatura deve ser exibida em Kelvin.The class supports four format specifiers: "G" and "C", which indicate that the temperature is to be displayed in Celsius; "F", which indicates that the temperature is to be displayed in Fahrenheit; and "K", which indicates that the temperature is to be displayed in Kelvin. Além disso, a IFormattable.ToString implementação também pode manipular uma cadeia de caracteres null de formato ou vazia.In addition, the IFormattable.ToString implementation also can handle a format string that is null or empty. Os outros dois ToString métodos definidos Temperature pela classe simplesmente encapsulam uma chamada para a IFormattable.ToString implementação.The other two ToString methods defined by the Temperature class simply wrap a call to the IFormattable.ToString implementation.

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

Em seguida, o exemplo a IFormattable.ToString seguir chama a implementação diretamente ou usando uma cadeia de caracteres de formato composto.The following example then calls the IFormattable.ToString implementation either directly or by using a composite format string.

public class Example
{
   public static void Main()
   {
      // Use composite formatting with format string in the format item.
      Temperature temp1 = new Temperature(0);
      Console.WriteLine("{0:C} (Celsius) = {0:K} (Kelvin) = {0:F} (Fahrenheit)\n", temp1);
      
      // Use composite formatting with a format provider.
      temp1 = new Temperature(-40);
      Console.WriteLine(String.Format(CultureInfo.CurrentCulture, "{0:C} (Celsius) = {0:K} (Kelvin) = {0:F} (Fahrenheit)", temp1));
      Console.WriteLine(String.Format(new CultureInfo("fr-FR"), "{0:C} (Celsius) = {0:K} (Kelvin) = {0:F} (Fahrenheit)\n", temp1));
      
      // Call ToString method with format string.
      temp1 = new Temperature(32);
      Console.WriteLine("{0} (Celsius) = {1} (Kelvin) = {2} (Fahrenheit)\n", 
                        temp1.ToString("C"), temp1.ToString("K"), temp1.ToString("F"));

      // Call ToString with format string and format provider
      temp1 = new Temperature(100)      ;
      NumberFormatInfo current = NumberFormatInfo.CurrentInfo;
      CultureInfo nl = new CultureInfo("nl-NL"); 
      Console.WriteLine("{0} (Celsius) = {1} (Kelvin) = {2} (Fahrenheit)", 
                        temp1.ToString("C", current), temp1.ToString("K", current), temp1.ToString("F", current));
      Console.WriteLine("{0} (Celsius) = {1} (Kelvin) = {2} (Fahrenheit)", 
                        temp1.ToString("C", nl), temp1.ToString("K", nl), temp1.ToString("F", nl));
   }
}
// The example displays the following output:
//    0.00 °C (Celsius) = 273.15 K (Kelvin) = 32.00 °F (Fahrenheit)
//    
//    -40.00 °C (Celsius) = 233.15 K (Kelvin) = -40.00 °F (Fahrenheit)
//    -40,00 °C (Celsius) = 233,15 K (Kelvin) = -40,00 °F (Fahrenheit)
//    
//    32.00 °C (Celsius) = 305.15 K (Kelvin) = 89.60 °F (Fahrenheit)
//    
//    100.00 °C (Celsius) = 373.15 K (Kelvin) = 212.00 °F (Fahrenheit)
//    100,00 °C (Celsius) = 373,15 K (Kelvin) = 212,00 °F (Fahrenheit)
Module Example
   Public Sub Main()
      ' Use composite formatting with format string in the format item.
      Dim temp1 As New Temperature(0)
      Console.WriteLine("{0:C} (Celsius) = {0:K} (Kelvin) = {0:F} (Fahrenheit)", temp1)
      Console.WriteLine()
      
      ' Use composite formatting with a format provider.
      temp1 = New Temperature(-40)
      Console.WriteLine(String.Format(CultureInfo.CurrentCulture, "{0:C} (Celsius) = {0:K} (Kelvin) = {0:F} (Fahrenheit)", temp1))
      Console.WriteLine(String.Format(New CultureInfo("fr-FR"), "{0:C} (Celsius) = {0:K} (Kelvin) = {0:F} (Fahrenheit)", temp1))
      Console.WriteLine()
      
      ' Call ToString method with format string.
      temp1 = New Temperature(32)
      Console.WriteLine("{0} (Celsius) = {1} (Kelvin) = {2} (Fahrenheit)", _
                        temp1.ToString("C"), temp1.ToString("K"), temp1.ToString("F"))
      Console.WriteLine()

      ' Call ToString with format string and format provider
      temp1 = New Temperature(100)      
      Dim current As NumberFormatInfo = NumberFormatInfo.CurrentInfo
      Dim nl As New CultureInfo("nl-NL") 
      Console.WriteLine("{0} (Celsius) = {1} (Kelvin) = {2} (Fahrenheit)", _
                        temp1.ToString("C", current), temp1.ToString("K", current), temp1.ToString("F", current))
      Console.WriteLine("{0} (Celsius) = {1} (Kelvin) = {2} (Fahrenheit)", _
                        temp1.ToString("C", nl), temp1.ToString("K", nl), temp1.ToString("F", nl))
   End Sub
End Module
' The example displays the following output:
'       0.00 °C (Celsius) = 273.15 K (Kelvin) = 32.00 °F (Fahrenheit)
'       
'       -40.00 °C (Celsius) = 233.15 K (Kelvin) = -40.00 °F (Fahrenheit)
'       -40,00 °C (Celsius) = 233,15 K (Kelvin) = -40,00 °F (Fahrenheit)
'       
'       32.00 °C (Celsius) = 305.15 K (Kelvin) = 89.60 °F (Fahrenheit)
'       
'       100.00 °C (Celsius) = 373.15 K (Kelvin) = 212.00 °F (Fahrenheit)
'       100,00 °C (Celsius) = 373,15 K (Kelvin) = 212,00 °F (Fahrenheit)

Comentários

A IFormattable interface converte um objeto em sua representação de cadeia de caracteres com base em uma cadeia de caracteres de formato e um provedor de formato.The IFormattable interface converts an object to its string representation based on a format string and a format provider.

Uma cadeia de caracteres de formato geralmente define a aparência geral de um objeto.A format string typically defines the general appearance of an object. Por exemplo, o .NET Framework dá suporte ao seguinte:For example, the .NET Framework supports the following:

Você também pode definir suas próprias cadeias de caracteres de formato para dar suporte à formatação dos tipos definidos pelo aplicativo.You can also define your own format strings to support formatting of your application-defined types.

Um provedor de formato retorna um objeto de formatação que normalmente define os símbolos usados na conversão de um objeto em sua representação de cadeia de caracteres.A format provider returns a formatting object that typically defines the symbols used in converting an object to its string representation. Por exemplo, quando você converte um número em um valor de moeda, um provedor de formato define o símbolo de moeda que aparece na cadeia de caracteres de resultado.For example, when you convert a number to a currency value, a format provider defines the currency symbol that appears in the result string. O .NET Framework define três provedores de formato:The .NET Framework defines three format providers:

Além disso, você pode definir seus próprios provedores de formato personalizados para fornecer informações específicas da cultura, da profissão ou específicas do setor, usadas na formatação.In addition, you can define your own custom format providers to supply culture-specific, profession-specific, or industry-specific information used in formatting. Para obter mais informações sobre como implementar a formatação personalizada usando um provedor de formato ICustomFormatterpersonalizado, consulte.For more information about implementing custom formatting by using a custom format provider, see ICustomFormatter.

A IFormattable interface define um método único, ToString, que fornece serviços de formatação para o tipo de implementação.The IFormattable interface defines a single method, ToString, that supplies formatting services for the implementing type. O ToString método pode ser chamado diretamente.The ToString method can be called directly. Além disso, ele é 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.In addition, it is 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. Esses métodos incluem Console.WriteLine(String, Object), String.Formate StringBuilder.AppendFormat(String, Object), entre outros.Such methods include Console.WriteLine(String, Object), String.Format, and StringBuilder.AppendFormat(String, Object), among others. O ToString método é chamado para cada item de formato na cadeia de caracteres de formato do método.The ToString method is called for each format item in the method's format string.

A IFormattable interface é implementada pelos tipos de dados base.The IFormattable interface is implemented by the base data types.

Notas aos Implementadores

As classes que exigem mais controle sobre a formatação de cadeias de caracteres IFormattableque ToString() o fornece devem implementar.Classes that require more control over the formatting of strings than ToString() provides should implement IFormattable.

Uma classe que implementa IFormattable deve oferecer suporte ao especificador de formato "G" (geral).A class that implements IFormattable 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çãoFor more information about formatting and formatting codes, see Formatting Types

Métodos

ToString(String, IFormatProvider)

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

Aplica-se a

Veja também