IFormatProvider IFormatProvider IFormatProvider IFormatProvider Interface

Определение

Предоставляет механизм для извлечения объекта с целью управления форматированием.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
Производный
Атрибуты

Примеры

В следующем примере показано как IFormatProvider реализацию можно изменить представление значения даты и времени.The following example illustrates how an IFormatProvider implementation can change the representation of a date and time value. В этом случае отдельная Дата отображается с помощью CultureInfo объекты, представляющие четыре разных языков и региональных параметров.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, 4, 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

Следующий пример иллюстрирует использование класса, реализующего IFormatProvider интерфейс и GetFormat метод.The following example illustrates the use of a class that implements the IFormatProvider interface and the GetFormat method. AcctNumberFormat Класса преобразует Int64 значение, представляющее номер счета в отформатированную запись 12-значное число.The AcctNumberFormat class converts an Int64 value that represents an account number to a formatted 12-digit account number. Его GetFormat метод возвращает ссылку на текущий AcctNumberFormat экземпляр Если formatType параметр ссылается на класс, реализующий ICustomFormatter; в противном случае GetFormat возвращает null.Its 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

Класс, реализующий IFormatProvider можно использовать в вызове форматирование и операция синтаксического анализа.The class that implements IFormatProvider can then be used in a call to a formatting and parsing operation. Например, следующий код вызывает String.Format(IFormatProvider, String, Object[]) метод для генерации строка, содержащая форматированное учетной записи 12-значное число.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.

Комментарии

IFormatProvider Интерфейс предоставляет объект, предоставляющий данные форматирования для форматирования и синтаксического анализа операций.The IFormatProvider interface supplies an object that provides formatting information for formatting and parsing operations. Операций форматирования преобразовать значение типа в строковое представление этого значения.Formatting operations convert the value of a type to the string representation of that value. Типичные методы форматирования, ToString методы типа, а также Format.Typical formatting methods are the ToString methods of a type, as well as Format. Операции анализа преобразовать строковое представление значения в тип с этим значением.Parsing operations convert the string representation of a value to a type with that value. Типичные методы синтаксического анализа, Parse и TryParse.Typical parsing methods are Parse and TryParse.

IFormatProvider Интерфейс состоит из единственного метода IFormatProvider.GetFormat.The IFormatProvider interface consists of a single method, IFormatProvider.GetFormat. GetFormat — Это метод обратного вызова: синтаксический анализ или форматирования метода он вызывает и передает его Type , представляющий тип объекта, форматирования или разбора метод ожидает, что предоставит сведения о форматировании.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. GetFormat Метод отвечает за возврат объекта этого типа.The GetFormat method is responsible for returning an object of that type.

IFormatProvider реализации, форматирование и методы анализа неявно часто используются.IFormatProvider implementations are often used implicitly by formatting and parsing methods. Например DateTime.ToString(String) метод неявно использует IFormatProvider реализации, представляющий текущий язык и региональные параметры системы.For example, the DateTime.ToString(String) method implicitly uses an IFormatProvider implementation that represents the system's current culture. IFormatProvider реализации можно также задать явным образом, методы, которые имеют параметр типа IFormatProvider, такие как Int32.Parse(String, IFormatProvider) и String.Format(IFormatProvider, String, Object[]).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[]).

.NET Framework содержит следующие три предопределенные IFormatProvider реализации, чтобы предоставить определяемые языком и региональными параметрами, используемый в форматирования или разбора значений числовых и даты и времени: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:

  • NumberFormatInfo Класс, который предоставляет сведения, используемые для форматирования чисел, например валюты, тысячи разделителя и десятичный разделитель для определенного языка и региональных параметров.The NumberFormatInfo class, which provides information that is used to format numbers, such as the currency, thousands separator, and decimal separator symbols for a particular culture. Сведения о строках стандартных форматов, распознаваемые NumberFormatInfo объекта и используется в операциях форматирования числовых, см. в разделе строки стандартных числовых форматов и строки настраиваемых числовых форматов.For information about the predefined format strings recognized by a NumberFormatInfo object and used in numeric formatting operations, see Standard Numeric Format Strings and Custom Numeric Format Strings.

  • DateTimeFormatInfo Класс, который предоставляет сведения, используемые для форматирования дат и времени, таких как разделитель даты и времени для конкретного языка и региональных параметров или порядок и формат даты год, месяц и день компонентов.The DateTimeFormatInfo class, which provides information that is used to format dates and times, such as the date and time separator symbols for a particular culture or the order and format of a date's year, month, and day components. Сведения о строках стандартных форматов, распознаваемые DateTimeFormatInfo объекта и используется в операциях форматирования числовых, см. в разделе Standard Date и Time Format Strings и Custom Date и Time Format Strings .For information about the predefined format strings recognized by a DateTimeFormatInfo object and used in numeric formatting operations, see Standard Date and Time Format Strings and Custom Date and Time Format Strings.

  • CultureInfo Класс, который представляет определенный язык и региональные параметры.The CultureInfo class, which represents a particular culture. Его GetFormat метод возвращает конкретный язык и региональные параметры NumberFormatInfo или DateTimeFormatInfo объекта, в зависимости от того, следует ли CultureInfo объект используется в форматирования или разбора операцию, которая включает в себя чисел, дат и времени.Its GetFormat method returns a culture-specific NumberFormatInfo or DateTimeFormatInfo object, depending on whether the CultureInfo object is used in a formatting or parsing operation that involves numbers or dates and times.

Платформа .NET Framework также поддерживает настраиваемое форматирование.The .NET Framework also supports custom formatting. Это обычно включает в себя создание класса форматирования, который реализует интерфейс IFormatProvider и ICustomFormatter.This typically involves the creation of a formatting class that implements both IFormatProvider and ICustomFormatter. Экземпляр этого класса передается как параметр метода, который выполняет пользовательские операции форматирования, такие как String.Format(IFormatProvider, String, Object[]) приведен пример такой пользовательские реализации, которая форматирует число как учетная запись 12-значное число.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.

Методы

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

Возвращает объекты, предоставляющие службы форматирования для заданного типа.Returns an object that provides formatting services for the specified type.

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

Дополнительно