IFormatProvider.GetFormat(Type) Méthode

Définition

Espace de noms:

System

Assembly:

System.Runtime.dll

Assembly:

mscorlib.dll

Assembly:

netstandard.dll

Retourne un objet qui assure des services de mise en forme pour le type spécifié.

C#

public object GetFormat (Type formatType);

C#

public object? GetFormat (Type? formatType);

Paramètres

formatType

Type

Objet qui spécifie le type d'objet de format à retourner.

Retours

Object

Une instance de l'objet spécifié par formatType, si l'implémentation IFormatProvider peut fournir ce type d'objet ; sinon, null.

Exemples

L’exemple suivant illustre l’utilisation d’une classe qui implémente l’interface IFormatProvider et la GetFormat méthode. La AcctNumberFormat classe convertit une Int64 valeur qui représente un numéro de compte en un numéro de compte mis en forme à 12 chiffres. Sa GetFormat méthode retourne une référence à elle-même si le formatType paramètre fait référence à une classe qui implémente ICustomFormatter; sinon, GetFormat retourne null.

C#

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;
   }
}

Une instance de la AcctNumberFormat classe peut ensuite être passée en tant qu’argument à une méthode qui fournit des services de mise en forme ou d’analyse. Par exemple, le code suivant transmet une AcctNumberFormat classe à la String.Format(IFormatProvider, String, Object[]) méthode pour générer un numéro de compte à 12 chiffres mis en forme.

C#

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.

Remarques

GetFormat est une méthode de rappel qui met en forme et analyse les méthodes appellent pour récupérer des informations sur le format de la chaîne d’entrée dans les opérations d’analyse ou le format de la chaîne de sortie dans les opérations de mise en forme. Dans le formatType paramètre, la méthode de mise en forme ou d’analyse transmet le type d’objet dont il a besoin pour effectuer son opération. Si l’implémentation IFormatProvider peut fournir cet objet de mise en forme ou d’analyse, elle retourne cet objet. Si ce n’est pas le cas, elle retourne null.

Par exemple, dans l’appel à la Int32.ToString(IFormatProvider) méthode, l’argument de méthode est un IFormatProvider objet qui fournit des informations sur la façon dont la représentation sous forme de chaîne de l’instance entière actuelle peut être mise en forme. Lorsque le runtime exécute la méthode, il appelle la méthode de l’objet IFormatProvider GetFormat et le transmet à un Type objet qui représente le NumberFormatInfo type. Si l’objet IFormatProvider peut fournir un NumberFormatInfo objet, il retourne cet objet. Si elle ne peut pas fournir un objet de ce type, elle retourne null.

Vous pouvez implémenter l’interface et la IFormatProvider GetFormat méthode dans les classes qui fournissent des services de mise en forme ou d’analyse personnalisés. L’implémentation IFormatProvider est ensuite passée en tant qu’argument à toute surcharge d’une méthode d’analyse ou de mise en forme qui a un paramètre de type IFormatProvider, tel que String.Format(IFormatProvider, String, Object[]), Int32.ToString(String, IFormatProvider)ou DateTime.Parse(String, IFormatProvider).

S’applique à