IFormattable.ToString(String, IFormatProvider) Método

Definición

Aplica formato al valor de la instancia actual utilizando el 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

Formato que se va a usar.The format to use.

o bien-or- Una referencia nula (Nothing en Visual Basic) para usar el formato predeterminado definido para el tipo de la implementación de IFormattable.A null reference (Nothing in Visual Basic) to use the default format defined for the type of the IFormattable implementation.

formatProvider
IFormatProvider

Proveedor que se va a usar para formatear el valor.The provider to use to format the value.

O bien-or- Una referencia nula (Nothing en Visual Basic) para obtener la información de formato numérico de la configuración regional actual del sistema operativo.A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system.

Devoluciones

Valor de la instancia actual en el formato especificado.The value of the current instance in the specified format.

Ejemplos

En el ejemplo siguiente se Temperature muestra una clase que implementa ToString el método.The following example demonstrates a Temperature class that implements the ToString method. Este ejemplo de código forma parte de un ejemplo más extenso proporcionado IFormattable para la clase.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

Comentarios

El ToString método convierte un valor en una representación de cadena que se puede expresar de varias maneras.The ToString method converts a value to a string representation that can be expressed in multiple ways. Su formato preciso depende de símbolos específicos o un orden determinado definido por referencias culturales, profesiones o sectores específicos.Its precise format depends on specific symbols or a specified order defined by specific cultures, professions, or industries. Puede llamar al método directamente.You can call the method directly. También se llama automáticamente mediante los Convert.ToString(Object) métodos y Convert.ToString(Object, IFormatProvider) , y mediante métodos que usan la característica de formato compuesto en String.Format(String, Object[])el .NET Framework, como, Console.WriteLine(String, Object[])y 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 obtener más información, vea formato compuesto).(For more information, see Composite Formatting.)

Los métodos de formato compuesto ToString llaman una vez al método para cada elemento de formato de una cadena de formato.Composite formatting methods call the ToString method once for each format item in a format string. Los parámetros que se pasan al método dependen del método de formato específico al que se llama y del contenido del elemento de formato, como se indica a continuación: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:

Nota

Los métodos de ToString formato compuesto llaman a la implementación de un objeto solo si no se les ICustomFormatter pasa un proveedor de formato o Format si el método del proveedor de formato nullpersonalizado devuelve.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.

El .NET Framework incluye tres proveedores de formato, que implementan la IFormatProvider interfaz:The .NET Framework includes three format providers, all of which implement the IFormatProvider interface:

  • NumberFormatInfoproporciona información de formato numérico, como los caracteres que se van a usar para los separadores decimales y de grupo, y la ortografía y la posición de los símbolos de moneda en valores monetarios.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.

  • DateTimeFormatInfoproporciona información de formato relacionada con la fecha y la hora, como la posición del mes, el día y el año en un patrón de fecha.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.

  • CultureInfocontiene la información de formato predeterminada en una referencia cultural concreta, incluida la información de formato numérico, y la información de formato relacionada con la fecha y la hora.CultureInfo contains the default formatting information in a specific culture, including the numeric format information, and date-related and time-related formatting information.

Además, puede definir su propio proveedor de formato personalizado.In addition, you can define your own custom format provider.

Notas a los implementadores

El ToString(String, IFormatProvider) método debe admitir el especificador de formato "G" (general).The ToString(String, IFormatProvider) method must support the "G" (general) format specifier. Además del especificador "G", la clase puede definir la lista de especificadores de formato que admite.Besides the "G" specifier, the class can define the list of format specifiers that it supports. Además, la clase debe estar preparada para controlar un especificador de formato que sea null.In addition, the class must be prepared to handle a format specifier that is null. Para obtener más información sobre el formato y los códigos de formato, vea aplicar formato a tipos.For more information about formatting and formatting codes, see Formatting Types.

Se aplica a

Consulte también: