IFormatProvider Arabirim

Tanım

Ad Alanı:

System

Bütünleştirilmiş Kod:

System.Runtime.dll

Bütünleştirilmiş Kod:

mscorlib.dll

Bütünleştirilmiş Kod:

netstandard.dll

Biçimlendirmeyi denetlemek için nesne almaya yönelik bir mekanizma sağlar.

public interface class IFormatProvider

public interface IFormatProvider

[System.Runtime.InteropServices.ComVisible(true)]
public interface IFormatProvider

type IFormatProvider = interface

[<System.Runtime.InteropServices.ComVisible(true)>]
type IFormatProvider = interface

Public Interface IFormatProvider

Türetilmiş

System.Globalization.CultureInfo

System.Globalization.DateTimeFormatInfo

System.Globalization.NumberFormatInfo

Öznitelikler

ComVisibleAttribute

Örnekler

Aşağıdaki örnekte, bir IFormatProvider uygulamanın tarih ve saat değerinin gösterimini nasıl değiştirebileceği gösterilmektedir. Bu durumda, dört farklı kültürü temsil eden nesneler kullanılarak CultureInfo tek bir tarih görüntülenir.

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

open System
open System.Globalization

let dateValue = DateTime(2009, 6, 1, 16, 37, 0)
let cultures = 
    [ CultureInfo "en-US"
      CultureInfo "fr-FR"
      CultureInfo "it-IT"
      CultureInfo "de-DE" ]

for culture in cultures do
    printfn $"{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

Aşağıdaki örnekte arabirimini ve yöntemini uygulayan bir sınıfın IFormatProvider kullanımı gösterilmektedir GetFormat . sınıfı, AcctNumberFormat hesap numarasını temsil eden bir Int64 değeri biçimlendirilmiş 12 basamaklı hesap numarasına dönüştürür. GetFormat parametresi uygulayan ICustomFormatterbir sınıfa başvuruyorsa formatType yöntemi geçerli AcctNumberFormat örneğe bir başvuru döndürür; aksi takdirde döndürür GetFormat 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;
   }
}

open System
open System.Globalization

type AcctNumberFormat() =
    let [<Literal>] ACCT_LENGTH = 12

    interface IFormatProvider with
        member this.GetFormat(formatType: Type) =
            if formatType = typeof<ICustomFormatter> then
                this
            else
                null

    interface ICustomFormatter with
        member this.Format(fmt: string, arg: obj, formatProvider: IFormatProvider) =
            // Provide default formatting if arg is not an Int64.
            // Provide default formatting for unsupported format strings.
            let ufmt = fmt.ToUpper CultureInfo.InvariantCulture
            if arg.GetType() = typeof<Int64> && (ufmt = "H" || ufmt = "I") then
                // Convert argument to a string.
                let result = string arg

                let result =
                    // If account number is less than 12 characters, pad with leading zeroes.
                    if result.Length < ACCT_LENGTH then
                        result.PadLeft(ACCT_LENGTH, '0')
                    else result
                
                let result =
                    // If account number is more than 12 characters, truncate to 12 characters.
                    if result.Length > ACCT_LENGTH then
                        result.Substring(0, ACCT_LENGTH)
                    else result

                // Integer-only format.
                if ufmt = "I" then 
                    result
                // Add hyphens for H format specifier.
                else // Hyphenated format.
                    result.Substring(0, 5) + "-" + result.Substring(5, 3) + "-" + result.Substring(8)
            else
                try
                    this.HandleOtherFormats(fmt, arg)
                with :? FormatException as e ->
                    raise (FormatException($"The format of '{fmt}' is invalid.", e))
            
    member _.HandleOtherFormats(format: string, arg: obj) =
        match arg with
        | :? IFormattable as arg ->
            arg.ToString(format, CultureInfo.CurrentCulture)
        | null -> 
            string arg
        | _ -> 
            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

Uygulayan IFormatProvider sınıf daha sonra bir biçimlendirme ve ayrıştırma işlemi çağrısında kullanılabilir. Örneğin, aşağıdaki kod biçimlendirilmiş 12 basamaklı hesap numarası içeren bir dize oluşturmak için yöntemini çağırır String.Format(IFormatProvider, String, Object[]) .

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.

open System
open System.Globalization

type DaysOfWeek = Monday = 1 | Tuesday = 2

[<EntryPoint>]
let main _ =
    let acctNumber = 104254567890L
    let balance = 16.34
    let wday = DaysOfWeek.Monday

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

    let wday = DaysOfWeek.Tuesday
    let output = 
        String.Format(AcctNumberFormat(),
                      "On {2}, the balance of account {0:I} was {1:C2}.",
                      acctNumber, balance, wday)
    printfn $"{output}"
    0

// 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.

Açıklamalar

Arabirim, IFormatProvider biçimlendirme ve ayrıştırma işlemleri için biçimlendirme bilgileri sağlayan bir nesne sağlar. Biçimlendirme işlemleri, bir türün değerini bu değerin dize gösterimine dönüştürür. Tipik biçimlendirme yöntemleri, hem bir türün yöntemleri hem de FormatyöntemleridirToString. Ayrıştırma işlemleri, bir değerin dize gösterimini bu değere sahip bir türe dönüştürür. Tipik ayrıştırma yöntemleri ve TryParse'tirParse.

IFormatProvider Arabirimi tek bir yöntemden oluşur: IFormatProvider.GetFormat. GetFormat bir geri çağırma yöntemidir: Ayrıştırma veya biçimlendirme yöntemi onu çağırır ve biçimlendirme veya ayrıştırma yönteminin biçimlendirme bilgilerini sağlayacağı nesne türünü temsil eden bir Type nesne geçirir. yöntemi GetFormat , bu türdeki bir nesneyi döndürmekten sorumludur.

IFormatProvider uygulamaları genellikle biçimlendirme ve ayrıştırma yöntemleri tarafından örtük olarak kullanılır. Örneğin, DateTime.ToString(String) yöntemi örtük olarak sistemin geçerli kültürünü temsil eden bir IFormatProvider uygulama kullanır. IFormatProvideruygulamaları, ve String.Format(IFormatProvider, String, Object[])gibi Int32.Parse(String, IFormatProvider) türünde IFormatProviderbir parametreye sahip yöntemler tarafından açıkça belirtilebilir.

.NET Framework, sayısal ve tarih ve saat değerlerini biçimlendirmek veya ayrıştırmak için kullanılan kültüre özgü bilgiler sağlamak için aşağıdaki önceden tanımlanmış IFormatProvider üç uygulamayı içerir:

• Sınıfı NumberFormatInfo , belirli bir kültür için para birimi, binlik ayırıcı ve ondalık ayırıcı sembolleri gibi sayıları biçimlendirmek için kullanılan bilgileri sağlar. Bir NumberFormatInfo nesne tarafından tanınan ve sayısal biçimlendirme işlemlerinde kullanılan önceden tanımlanmış biçim dizeleri hakkında bilgi için bkz. Standart Sayısal Biçim Dizeleri ve Özel Sayısal Biçim Dizeleri.

• Belirli DateTimeFormatInfo bir kültür için tarih ve saat ayırıcı simgeleri ya da bir tarihin yıl, ay ve gün bileşenlerinin sırası ve biçimi gibi tarihleri ve saatleri biçimlendirmek için kullanılan bilgileri sağlayan sınıfı. Bir DateTimeFormatInfo nesne tarafından tanınan ve sayısal biçimlendirme işlemlerinde kullanılan önceden tanımlanmış biçim dizeleri hakkında bilgi için bkz. Standart Tarih ve Saat Biçim Dizeleri ve Özel Tarih ve Saat Biçim Dizeleri.

• CultureInfo Belirli bir kültürü temsil eden sınıfı. YöntemiGetFormat, nesnenin CultureInfo sayı veya DateTimeFormatInfo tarih ve saat içeren bir biçimlendirme veya ayrıştırma işleminde kullanılıp kullanılmadığına bağlı olarak kültüre özgü NumberFormatInfo veya nesne döndürür.

.NET Framework özel biçimlendirmeyi de destekler. Bu genellikle hem ICustomFormatterhem de IFormatProvider uygulayan bir biçimlendirme sınıfı oluşturmayı içerir. Daha sonra bu sınıfın bir örneği, bir sayıyı 12 basamaklı hesap numarası olarak biçimlendiren böyle bir özel uygulamanın çizimini sağlar gibi String.Format(IFormatProvider, String, Object[]) özel biçimlendirme işlemi gerçekleştiren bir yönteme parametre olarak geçirilir.

Yöntemler

GetFormat(Type)

Belirtilen tür için biçimlendirme hizmetleri sağlayan bir nesne döndürür.

Ayrıca bkz.

• ICustomFormatter
• IFormattable
• .NET'te Biçimlendirme Türleri
• Nasıl yapılır: Özel Sayısal Biçim Sağlayıcıları Tanımlama ve Kullanma