ICustomFormatter Arabirim (System) | Microsoft Docs
Aşağıdaki örnek, tamsayı değerlerinin ikili, sekizlik ve onaltılık biçimlendirmesine izin vermek için ICustomFormatter uygular.The following example implements ICustomFormatter to allow binary, octal, and hexadecimal formatting of integral values. Bu örnekte, tek bir sınıf IBinaryFormatter, hem ICustomFormatter hem de IFormatProvideruygular.In this example, a single class, IBinaryFormatter, implements both ICustomFormatter and IFormatProvider. IFormatProvider.GetFormat yöntemi formatType parametresinin bir ICustomFormatter türünü temsil edip etmediğini belirler.Its IFormatProvider.GetFormat method determines whether the formatType parameter represents an ICustomFormatter type. Varsa, BinaryFormatter kendi örneğini döndürür; Aksi takdirde, nulldöndürür.If it does, BinaryFormatter returns an instance of itself; otherwise, it returns null. ICustomFormatter.Format uygulamasının biçim parametresinin, ikili için desteklenen üç biçim dizesinin ("B", sekizlik için "O" ve onaltılı için "H") biri olup olmadığını belirler ve arg parametresini uygun şekilde biçimlendirir.Its ICustomFormatter.Format implementation determines whether the format parameter is one of the three supported format strings ("B" for binary, "O" for octal, and "H" for hexadecimal) and formats the arg parameter appropriately. Aksi takdirde, arg nullyoksa, varsa arg parametrenin IFormattable.ToString uygulamasını veya varsa parametresiz ToString yöntemini çağırır.Otherwise, if arg is not null, it calls the arg parameter's IFormattable.ToString implementation, if one exists, or its parameterless ToString method, if one does not. arg null, yöntemi String.Emptydöndürür.If arg is null, the method returns String.Empty.
ICustomFormatter arabirimi tek bir yöntemi içerir, ICustomFormatter.Format.The ICustomFormatter interface includes a single method, ICustomFormatter.Format. Bu arabirim bir başvuru veya değer türü tarafından uygulandığında, Format yöntemi bir nesnenin değerinin özel biçimli bir dize gösterimini döndürür.When this interface is implemented by a reference or value type, the Format method returns a custom-formatted string representation of an object's value.
Genellikle ICustomFormatter arabirimi, bir IFormatProvider parametresi içeren iki .NET Framework bileşik dize biçimlendirme yönteminin davranışını özelleştirmek için IFormatProvider arabirimi ile uygulanır.Typically, the ICustomFormatter interface is implemented with the IFormatProvider interface to customize the behavior of two .NET Framework composite string formatting methods that include an IFormatProvider parameter. Özellikle ICustomFormatter arabirimi, String.Format(IFormatProvider, String, Object) ve StringBuilder.AppendFormat(IFormatProvider, String, Object) yöntemlerine geçirilen bir nesne değerinin özel biçimlendirmesini sağlayabilir.Specifically, the ICustomFormatter interface can provide custom formatting of the value of an object passed to the String.Format(IFormatProvider, String, Object) and StringBuilder.AppendFormat(IFormatProvider, String, Object) methods.
Bir nesnenin değerinin özel bir gösterimini sağlamak için şunları yapmanız gerekir:Providing a custom representation of an object's value requires that you do the following:
ICustomFormatter arabirimini ve tek üyesini uygulayan, Format yöntemi olan bir sınıf tanımlayın.Define a class that implements the ICustomFormatter interface and its single member, the Format method.
IFormatProvider arabirimini ve tek üyesini uygulayan, GetFormat yöntemi olan bir sınıf tanımlayın.Define a class that implements the IFormatProvider interface and its single member, the GetFormat method. GetFormat yöntemi ICustomFormatter uygulamanızın bir örneğini döndürür.The GetFormat method returns an instance of your ICustomFormatter implementation. Genellikle, tek bir sınıf hem ICustomFormatter hem de IFormatProvideruygular.Often, a single class implements both ICustomFormatter and IFormatProvider. Bu durumda, sınıfın GetFormat uygulamasının yalnızca bir örneğini döndürür.In that case, the class's GetFormat implementation just returns an instance of itself.
IFormatProvider uygulamasını String.Format(IFormatProvider, String, Object) yönteminin provider bağımsız değişkeni olarak veya karşılaştırılabilir bir yöntem olarak geçirin.Pass the IFormatProvider implementation as the provider argument of the String.Format(IFormatProvider, String, Object) method or a comparable method.
.NET Framework yöntemi, kendi yerine özel biçimlendirmenizi kullanacaktır.The .NET Framework method will then use your custom formatting instead of its own.
Ortak dil çalışma zamanı, bileşik biçim dizesindeki her biçim öğesi için ICustomFormatter uygulamanızı kullanmayı dener.The common language runtime attempts to use your ICustomFormatter implementation for every format item in a composite format string. Sonuç olarak, ICustomFormatter uygulamanızın, işlemek için tasarlanmamış nesnelere veya değerlere biçimlendirme hizmetleri sağlamak için çağrılabilmesi beklenir.As a result, you should expect that your ICustomFormatter implementation will be called to provide formatting services to objects or values that it is not designed to handle. Bu durumlarda, Format(String, Object, IFormatProvider) yönteminizin bu nesne veya değer için uygun biçimlendirme yöntemini çağırması gerekir.In these cases, your Format(String, Object, IFormatProvider) method must call the appropriate formatting method for that object or value.
İki tür ICustomFormatter uygulaması vardır: iç ve uzantı.There are two kinds of ICustomFormatter implementations: intrinsic and extension.
İç uygulamalar, uygulama tanımlı bir nesne için özel biçimlendirme sağlayan uygulamalardır.Intrinsic implementations are implementations that provide custom formatting for an application-defined object. Bu durumda, uygulamanız aşağıdakileri içermelidir:In this case, your implementation should include the following: -Nesnenin biçimlendirmesini tanımlayan biçim dizelerinin tanımı.- A definition of format strings that define the formatting of the object. Biçim dizeleri isteğe bağlıdır.Format strings are optional. Genellikle, "G" veya "g" biçim dizesi genel (veya en yaygın olarak kullanılan) biçimi tanımlar.Typically, a "G" or "g" format string defines the general (or most commonly used) format. Ancak, seçtiğiniz herhangi bir biçim dizesini tanımlamanız ücretsizdir.However, you are free to define any format strings that you choose. Ayrıca, büyük/küçük harfe duyarlı veya büyük/küçük harfe duyarlı olup olmadığına karar verebilirsiniz.You are also free to decide whether they are case-sensitive or case-insensitive.
-Format(String, Object, IFormatProvider) metoduna geçirilen nesne türünün uygulama tanımlı türde olduğundan emin olmak için bir test.- A test to ensure that the type of the object passed to your Format(String, Object, IFormatProvider) method is your application-defined type. Aksi takdirde, varsa nesnenin IFormattable uygulamasını, varsa veya ToString() yöntemini çağırmanız gerekir.If it is not, you should call the object's IFormattable implementation, if one exists, or its ToString() method, if it does not. Bu yöntem çağrılarının oluşturmakta olduğu tüm özel durumları işlemeye hazırlanmalısınız.You should be prepared to handle any exceptions these method calls might throw.
-Uygulamanız biçim dizelerini destekliyorsa, null biçim dizesini işlemek için kod.- Code to handle a null format string, if your implementation supports format strings. En yaygın yaklaşım, bir null biçim dizesinin genel biçim belirticisi ile değiştirilmesini kullanmaktır.The most common approach is to replace a null format string with the general format specifier.
-Uygulamanızın desteklediği biçim dizelerini işlemek için kod.- Code to handle any format strings that your implementation supports.
-Desteklenmeyen biçim dizelerini işlemek için kod.- Code to handle format strings that you do not support. En yaygın yaklaşım bir FormatExceptionoluşturmaktır, ancak varsayılan biçimlendirme sağlayabiliriz.The most common approach is to throw a FormatException, although you can provide default formatting.
Uzantı uygulamaları, zaten biçimlendirme desteği olan bir tür için özel biçimlendirme sağlayan uygulamalardır.Extension implementations are implementations that provide custom formatting for a type that already has formatting support. Örneğin, bir tamsayı türünü belirli basamaklar arasında tire ile biçimlendiren bir CustomerNumberFormatter tanımlayabilirsiniz.For example, you could define a CustomerNumberFormatter that formats an integral type with hyphens between specific digits. Bu durumda, uygulamanız aşağıdakileri içermelidir:In this case, your implementation should include the following: -Nesnenin biçimlendirmesini genişleten biçim dizelerinin tanımı.- A definition of format strings that extend the formatting of the object. Bu biçim dizeleri gereklidir, ancak türün varolan biçim dizeleri ile çakışmaması gerekir.These format strings are required, but they must not conflict with the type's existing format strings. Örneğin, Int32 türü için biçimlendirme uzatıyorsanız, diğerleri arasında "C", "D", "E", "F" ve "G" biçim belirticilerini uygulamamalısınız.For example, if you are extending formatting for the Int32 type, you should not implement the "C", "D", "E", "F", and "G" format specifiers, among others.
-Format(String, Object, IFormatProvider) metoduna geçirilen nesne türünün, uzantınızı desteklediği bir tür olduğunu belirten bir test.- A test that the type of the object passed to your Format(String, Object, IFormatProvider) method is a type whose formatting your extension supports. Aksi takdirde, varsa nesnenin IFormattable uygulamasını ya da nesnenin parametresiz ToString() yöntemini çağırın.If it is not, call the object's IFormattable implementation, if one exists, or the object's parameterless ToString() method, if it does not. Bu yöntem çağrılarının oluşturmakta olduğu tüm özel durumları işlemeye hazırlanmalısınız.You should be prepared to handle any exceptions these method calls might throw.
-Uzantınızın desteklediği biçim dizelerini işlemek için kod.- Code to handle any format strings that your extension supports.
-Uzantınızın desteklemediği biçim dizelerini işlemek için kod.- Code to handle any format strings that your extension does not support. Bu, türün IFormattable uygulamasına geçirilmesi gerekir.These should be passed on to the type's IFormattable implementation. Bu yöntem çağrılarının oluşturmakta olduğu tüm özel durumları işlemeye hazırlanmalısınız.You should be prepared to handle any exceptions these method calls might throw.