IFormatProvider.GetFormat(Type) Метод

Определение

Пространство имен:

System

Сборки:

netstandard.dll, System.Runtime.dll

Возвращает объекты, предоставляющие службы форматирования для заданного типа.

C#

public object? GetFormat(Type? formatType);

Параметры

formatType

Type

Объект, определяющий тип возвращаемого объекта форматирования.

Возвращаемое значение

Object

Экземпляр объекта, заданного в параметре formatType, если реализация IFormatProvider может предоставить объект такого типа; в противном случае — null.

Примеры

В следующем примере показано использование класса , реализующего IFormatProvider интерфейс и GetFormat метод . Класс AcctNumberFormat преобразует Int64 значение, представляющее номер счета, в форматированный 12-значный номер счета. Его GetFormat метод возвращает ссылку на себя, если formatType параметр ссылается на класс, реализующий ICustomFormatter; в противном случае GetFormat возвращает .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;
   }
}

Затем экземпляр AcctNumberFormat класса можно передать в качестве аргумента методу, который предоставляет службы форматирования или анализа. Например, следующий код передает AcctNumberFormat класс String.Format(IFormatProvider, String, Object[]) в метод для создания отформатированного 12-значного номера счета.

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.

Комментарии

GetFormat — это метод обратного вызова, который вызывается методами форматирования и анализа для получения сведений о формате входной строки в операциях синтаксического анализа или о формате выходной строки в операциях форматирования. В параметре formatType метод форматирования или синтаксического анализа передает тип объекта, необходимый для выполнения операции. IFormatProvider Если реализация может предоставить этот объект форматирования или синтаксического анализа, она возвращает этот объект. В противном случае возвращается null.

Например, в вызове Int32.ToString(IFormatProvider) метода аргумент метода представляет собой объект , предоставляющий IFormatProvider сведения о том, как может быть отформатировано строковое представление текущего целочисленного экземпляра. Когда среда выполнения выполняет метод , она вызывает IFormatProvider метод объекта GetFormat и передает ему Type объект , представляющий NumberFormatInfo тип . IFormatProvider Если объект может предоставить NumberFormatInfo объект , он возвращает этот объект. Если он не может предоставить объект этого типа, он возвращает .null

Интерфейс и GetFormat метод можно реализовать IFormatProvider в классах, предоставляющих пользовательские службы форматирования или синтаксического анализа. Затем IFormatProvider реализация передается в качестве аргумента в любую перегрузку метода синтаксического анализа или форматирования с параметром типа IFormatProvider, например String.Format(IFormatProvider, String, Object[]), Int32.ToString(String, IFormatProvider)или DateTime.Parse(String, IFormatProvider).

Применяется к