IFormatProvider IFormatProvider IFormatProvider IFormatProvider Interface

Definizione

Fornisce un meccanismo per il recupero di un oggetto allo scopo di controllare la formattazione.Provides a mechanism for retrieving an object to control formatting.

public interface class IFormatProvider
[System.Runtime.InteropServices.ComVisible(true)]
public interface IFormatProvider
type IFormatProvider = interface
Public Interface IFormatProvider
Derivato
Attributi

Esempi

Nell'esempio seguente viene illustrato il modo IFormatProvider in cui un'implementazione può modificare la rappresentazione di un valore di data e ora.The following example illustrates how an IFormatProvider implementation can change the representation of a date and time value. In questo caso, viene visualizzata una singola data utilizzando CultureInfo oggetti che rappresentano quattro impostazioni cultura diverse.In this case, a single date is displayed by using CultureInfo objects that represent four different cultures.

using System;
using System.Globalization;

public class Example
{
   public static void Main()
   {
      DateTime dateValue = new DateTime(2009, 6, 1, 16, 37, 0);
      CultureInfo[] cultures = { new CultureInfo("en-US"), 
                                 new CultureInfo("fr-FR"),
                                 new CultureInfo("it-IT"),
                                 new CultureInfo("de-DE") };
      foreach (CultureInfo culture in cultures)
         Console.WriteLine("{0}: {1}", culture.Name, dateValue.ToString(culture));
   }
}
// The example displays the following output:
//       en-US: 6/1/2009 4:37:00 PM
//       fr-FR: 01/06/2009 16:37:00
//       it-IT: 01/06/2009 16.37.00
//       de-DE: 01.06.2009 16:37:00
Imports System.Globalization

Module Example
   Public Sub Main()
      Dim dateValue As Date = #06/01/2009 4:37PM#
      Dim cultures() As CultureInfo = {New CultureInfo("en-US"), _
                                       New CultureInfo("fr-FR"), _
                                       New CultureInfo("it-IT"), _
                                       New CultureInfo("de-DE") }
      For Each culture As CultureInfo In cultures
         Console.WriteLine("{0}: {1}", culture.Name, dateValue.ToString(culture))
      Next                                        
   End Sub
End Module
' The example displays the following output:
'       en-US: 6/1/2009 4:37:00 PM
'       fr-FR: 01/06/2009 16:37:00
'       it-IT: 01/06/2009 16.37.00
'       de-DE: 01.06.2009 16:37:00

Nell'esempio seguente viene illustrato l'utilizzo di una classe che implementa l' IFormatProvider interfaccia e il GetFormat metodo.The following example illustrates the use of a class that implements the IFormatProvider interface and the GetFormat method. La AcctNumberFormat classe converte un Int64 valore che rappresenta un numero di conto in un numero di conto a 12 cifre formattato.The AcctNumberFormat class converts an Int64 value that represents an account number to a formatted 12-digit account number. GetFormat formatType AcctNumberFormat ICustomFormatterIl metodo restituisce un riferimento all'istanza corrente se il parametro fa riferimento a una classe che implementa; in caso contrario null, restituisce. GetFormatIts GetFormat method returns a reference to the current AcctNumberFormat instance if the formatType parameter refers to a class that implements ICustomFormatter; otherwise, GetFormat returns null.

public class AcctNumberFormat : IFormatProvider, ICustomFormatter
{
   private const int ACCT_LENGTH = 12;
   
   public object GetFormat(Type formatType)
   {
      if (formatType == typeof(ICustomFormatter))
         return this;
      else
         return null;
   }
   
   public string Format(string fmt, object arg, IFormatProvider formatProvider) 
   {
      // Provide default formatting if arg is not an Int64.
      if (arg.GetType() != typeof(Int64))
         try {
            return HandleOtherFormats(fmt, arg); 
         }
         catch (FormatException e) {
            throw new FormatException(String.Format("The format of '{0}' is invalid.", fmt), e);
         }
      
      // Provide default formatting for unsupported format strings.
      string ufmt = fmt.ToUpper(CultureInfo.InvariantCulture);
      if (! (ufmt == "H" || ufmt == "I")) 
         try {
            return HandleOtherFormats(fmt, arg);
         }
         catch (FormatException e) {
            throw new FormatException(String.Format("The format of '{0}' is invalid.", fmt), e);
         }
           
      // Convert argument to a string.
      string result = arg.ToString();
      
      // If account number is less than 12 characters, pad with leading zeroes.
      if (result.Length < ACCT_LENGTH)
         result = result.PadLeft(ACCT_LENGTH, '0');
      // If account number is more than 12 characters, truncate to 12 characters.
      if (result.Length > ACCT_LENGTH)
         result = result.Substring(0, ACCT_LENGTH);   

      if (ufmt == "I")                    // Integer-only format. 
         return result;
      // Add hyphens for H format specifier.
      else                                         // Hyphenated format.
         return result.Substring(0, 5) + "-" + result.Substring(5, 3) + "-" + result.Substring(8);
   }

   private string HandleOtherFormats(string format, object arg)
   {
      if (arg is IFormattable) 
         return ((IFormattable)arg).ToString(format, CultureInfo.CurrentCulture);
      else if (arg != null)
         return arg.ToString();
      else
         return String.Empty;
   }
}
Public Class AcctNumberFormat : Implements IFormatProvider, ICustomFormatter

   Private Const ACCT_LENGTH As Integer = 12
   
   Public Function GetFormat(formatType As Type) As Object _
                   Implements IFormatProvider.GetFormat
      If formatType Is GetType(ICustomFormatter) Then
         Return Me
      Else
         Return Nothing
      End If
   End Function
   
   Public Function Format(fmt As String, arg As Object, formatProvider As IFormatProvider) As String _
                          Implements ICustomFormatter.Format

      ' Provide default formatting if arg is not an Int64.
       If Not TypeOf arg Is Int64 Then
         Try 
            Return HandleOtherFormats(fmt, arg) 
         Catch e As FormatException 
            Throw New FormatException(String.Format("The format of '{0}' is invalid.", fmt), e)
         End Try
       End If   
                     
      ' Provider default formatting for unsupported format strings.
      Dim ufmt As String = fmt.ToUpper(CultureInfo.InvariantCulture)
      If Not (ufmt = "H" Or ufmt = "I") Then
         Try
            Return HandleOtherFormats(fmt, arg)
         Catch e As FormatException 
            Throw New FormatException(String.Format("The format of '{0}' is invalid.", fmt), e)
         End Try
      End If   

      ' Convert argument to a string.
      Dim result As String = arg.ToString()
      
      ' If account number is less than 12 characters, pad with leading zeroes.
      If result.Length < ACCT_LENGTH Then result = result.PadLeft(ACCT_LENGTH, "0"c)
      ' If account number is more than 12 characters, truncate to 12 characters.
      If result.Length > ACCT_LENGTH Then result = Left(result, ACCT_LENGTH)   
      
      If ufmt = "I"                              ' Integer-only format.
         Return result
      ' Add hyphens for H format specifier.
      Else                                       ' Hypenated format.
         Return Left(result, 5) & "-" & Mid(result, 6, 3) & "-" & Right(result, 4)
      End If   
   End Function   

   Private Function HandleOtherFormats(fmt As String, arg As Object) As String
      If TypeOf arg Is IFormattable Then
         Return DirectCast(arg, IFormattable).ToString(fmt, CultureInfo.CurrentCulture)
      ElseIf arg IsNot Nothing Then
         Return arg.ToString()
      Else
         Return String.Empty
      End If
   End Function
End Class

La classe che implementa IFormatProvider può quindi essere utilizzata in una chiamata a un'operazione di formattazione e analisi.The class that implements IFormatProvider can then be used in a call to a formatting and parsing operation. Il codice seguente, ad esempio, chiama String.Format(IFormatProvider, String, Object[]) il metodo per generare una stringa che contiene un numero di conto a 12 cifre formattato.For example, the following code calls the String.Format(IFormatProvider, String, Object[]) method to generate a string that contains a formatted 12-digit account number.

using System;
using System.Globalization;

public enum DaysOfWeek { Monday=1, Tuesday=2 };

public class TestFormatting
{
   public static void Main()
   {
      long acctNumber;
      double balance; 
      DaysOfWeek wday; 
      string output;

      acctNumber = 104254567890;
      balance = 16.34;
      wday = DaysOfWeek.Monday;

      output = String.Format(new AcctNumberFormat(), 
                             "On {2}, the balance of account {0:H} was {1:C2}.", 
                             acctNumber, balance, wday);
      Console.WriteLine(output);

      wday = DaysOfWeek.Tuesday;
      output = String.Format(new AcctNumberFormat(), 
                             "On {2}, the balance of account {0:I} was {1:C2}.", 
                             acctNumber, balance, wday);
      Console.WriteLine(output);
   }
}
// The example displays the following output:
//       On Monday, the balance of account 10425-456-7890 was $16.34.
//       On Tuesday, the balance of account 104254567890 was $16.34.
Imports System.Globalization

Public Enum DaysOfWeek As Long
   Monday = 1
   Tuesday = 2
End Enum

Module TestFormatting
   Public Sub Main()
      Dim acctNumber As Long, balance As Double 
      Dim wday As DaysOfWeek 
      Dim output As String

      acctNumber = 104254567890
      balance = 16.34
      wday = DaysOfWeek.Monday

      output = String.Format(New AcctNumberFormat(), "On {2}, the balance of account {0:H} was {1:C2}.", acctNumber, balance, wday)
      Console.WriteLine(output)

      wday = DaysOfWeek.Tuesday
      output = String.Format(New AcctNumberFormat(), "On {2}, the balance of account {0:I} was {1:C2}.", acctNumber, balance, wday)
      Console.WriteLine(output)
   End Sub
End Module
' The example displays the following output:
'    On Monday, the balance of account 10425-456-7890 was $16.34.
'    On Tuesday, the balance of account 104254567890 was $16.34.

Commenti

L' IFormatProvider interfaccia fornisce un oggetto che fornisce informazioni sulla formattazione per le operazioni di formattazione e analisi.The IFormatProvider interface supplies an object that provides formatting information for formatting and parsing operations. Le operazioni di formattazione convertono il valore di un tipo nella rappresentazione di stringa di tale valore.Formatting operations convert the value of a type to the string representation of that value. I metodi di formattazione tipici ToString sono i metodi di un tipo, Formatnonché.Typical formatting methods are the ToString methods of a type, as well as Format. Le operazioni di analisi convertono la rappresentazione di stringa di un valore in un tipo con tale valore.Parsing operations convert the string representation of a value to a type with that value. I metodi di analisi tipici Parse sono TryParsee.Typical parsing methods are Parse and TryParse.

L' IFormatProvider interfaccia è costituita da un singolo IFormatProvider.GetFormatmetodo,.The IFormatProvider interface consists of a single method, IFormatProvider.GetFormat. GetFormatè un metodo di callback: Il metodo di analisi o formattazione lo chiama e lo passa a Type un oggetto che rappresenta il tipo di oggetto che il metodo di formattazione o analisi prevede fornirà informazioni di formattazione.GetFormat is a callback method: The parsing or formatting method calls it and passes it a Type object that represents the type of object that the formatting or parsing method expects will provide formatting information. Il GetFormat metodo è responsabile della restituzione di un oggetto di quel tipo.The GetFormat method is responsible for returning an object of that type.

IFormatProviderle implementazioni vengono spesso usate in modo implicito dai metodi di formattazione e analisi.IFormatProvider implementations are often used implicitly by formatting and parsing methods. Il DateTime.ToString(String) metodo, ad esempio, utilizza in modo IFormatProvider implicito un'implementazione di che rappresenta le impostazioni cultura correnti del sistema.For example, the DateTime.ToString(String) method implicitly uses an IFormatProvider implementation that represents the system's current culture. IFormatProviderle implementazioni possono anche essere specificate in modo esplicito dai metodi che hanno un IFormatProviderparametro di tipo, String.Format(IFormatProvider, String, Object[])ad esempio e. Int32.Parse(String, IFormatProvider)IFormatProvider implementations can also be specified explicitly by methods that have a parameter of type IFormatProvider, such as Int32.Parse(String, IFormatProvider) and String.Format(IFormatProvider, String, Object[]).

Il .NET Framework include le tre implementazioni predefinite IFormatProvider seguenti per fornire informazioni specifiche delle impostazioni cultura usate per la formattazione o l'analisi dei valori numerici e di data e ora:The .NET Framework includes the following three predefined IFormatProvider implementations to provide culture-specific information that is used in formatting or parsing numeric and date and time values:

Il .NET Framework supporta anche la formattazione personalizzata.The .NET Framework also supports custom formatting. Ciò comporta in genere la creazione di una classe di formattazione che IFormatProvider implementa ICustomFormattersia che.This typically involves the creation of a formatting class that implements both IFormatProvider and ICustomFormatter. Un'istanza di questa classe viene quindi passata come parametro a un metodo che esegue un'operazione di formattazione personalizzata, ad String.Format(IFormatProvider, String, Object[]) esempio l'esempio fornisce un'illustrazione di tale implementazione personalizzata che formatta un numero come numero di conto a 12 cifre.An instance of this class is then passed as a parameter to a method that performs a custom formatting operation, such as String.Format(IFormatProvider, String, Object[]) The example provides an illustration of such a custom implementation that formats a number as a 12-digit account number.

Metodi

GetFormat(Type) GetFormat(Type) GetFormat(Type) GetFormat(Type)

Restituisce un oggetto che fornisce servizi di formattazione per il tipo specificato.Returns an object that provides formatting services for the specified type.

Si applica a

Vedi anche