IFormattable.ToString(String, IFormatProvider) Metodo

Definizione

Formatta il valore dell'istanza corrente usando il formato specificato.

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

Parametri

format
String

Formato da usare.

-oppure- Riferimento null (Nothing in Visual Basic) per usare il formato predefinito per il tipo dell'implementazione di IFormattable.

formatProvider
IFormatProvider

Provider da utilizzare per formattare il valore.

-oppure- Riferimento null (Nothing in Visual Basic) per ottenere le informazioni sul formato numerico dalle impostazioni locali correnti del sistema operativo.

Restituisce

String

Valore dell'istanza corrente nel formato specificato.

Esempio

Nell'esempio seguente viene illustrata una Temperature classe che implementa il ToString metodo . Questo esempio di codice fa parte di un esempio più ampio fornito per la 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

Commenti

Il ToString metodo converte un valore in una rappresentazione di stringa che può essere espressa in diversi modi. Il suo formato preciso dipende da simboli specifici o da un ordine specificato definito da culture, professioni o industrie specifiche. È possibile chiamare direttamente il metodo . Viene inoltre chiamato automaticamente dai metodi Convert.ToString(Object) e Convert.ToString(Object, IFormatProvider) e dai metodi che utilizzano la funzionalità di formattazione composita in .NET Framework, come String.Format(String, Object[]), Console.WriteLine(String, Object[]) e StringBuilder.AppendFormat(String, Object[]). Per altre informazioni, vedere Formattazione composita.

I metodi di formattazione compositi chiamano il ToString metodo una volta per ogni elemento di formato in una stringa di formato. I parametri passati al metodo dipendono dal metodo di formattazione specifico chiamato e dal contenuto dell'elemento di formato, come indicato di seguito:

  • Se l'elemento di formato non include una stringa di formato ( ad esempio, se l'elemento di formato è semplicemente {0}), viene passato null come valore del System.String parametro .

  • Se l'elemento di formato include una stringa di formato ,ad esempio {0:G}, tale stringa di formato viene passata come valore del System.String parametro .

  • Se la chiamata al metodo originale non include un System.IFormatProvider parametro, CultureInfo.CurrentCulture viene passato come valore del System.IFormatProvider parametro .

  • Se la chiamata al metodo originale include un System.IFormatProvider parametro, il provider fornito nella chiamata al metodo viene passato come valore del System.IFormatProvider parametro .

Nota

L'implementazione di ToString un oggetto viene chiamata dai metodi di formattazione composita solo se non vengono passati un ICustomFormatter provider di formato o se il Format metodo del provider di formato personalizzato restituisce null.

Il .NET Framework include tre provider di formato, tutti che implementano l'interfaccia IFormatProvider :

  • NumberFormatInfo fornisce informazioni sulla formattazione numerica, ad esempio i caratteri da utilizzare per i separatori decimali e di gruppo, nonché l'ortografia e la posizione dei simboli di valuta nei valori monetari.

  • DateTimeFormatInfo fornisce informazioni di formattazione relative alla data e all'ora, ad esempio la posizione del mese, il giorno e l'anno in un modello di data.

  • CultureInfo contiene le informazioni di formattazione predefinite in impostazioni cultura specifiche, incluse le informazioni sul formato numerico e le informazioni sulla formattazione relative alla data e all'ora.

Inoltre, è possibile definire un provider di formato personalizzato.

Note per gli implementatori

Il ToString(String, IFormatProvider) metodo deve supportare l'identificatore di formato "G" (generale). Oltre all'identificatore "G", la classe può definire l'elenco di identificatori di formato supportati. Inoltre, la classe deve essere preparata per gestire un identificatore di formato che è null. Per altre informazioni sulla formattazione e sulla formattazione dei codici, vedere Formattazione dei tipi.

Si applica a

Vedi anche