ICustomFormatter Interfaccia
Definizione
Importante
Alcune informazioni sono relative alla release non definitiva del prodotto, che potrebbe subire modifiche significative prima della release definitiva. Microsoft non riconosce alcuna garanzia, espressa o implicita, in merito alle informazioni qui fornite.
Definisce un metodo che supporta la formattazione personalizzata del valore di un oggetto.
public interface class ICustomFormatterpublic interface ICustomFormatter[System.Runtime.InteropServices.ComVisible(true)]
public interface ICustomFormattertype ICustomFormatter = interface[<System.Runtime.InteropServices.ComVisible(true)>]
type ICustomFormatter = interfacePublic Interface ICustomFormatter- Attributi
Esempio
L'esempio seguente implementa ICustomFormatter per consentire la formattazione binaria, ottale ed esadecimale dei valori integrali. In questo esempio, una singola classe, MyFormatter, implementa sia che IFormatProviderICustomFormatter . Il metodo IFormatProvider.GetFormat determina se il formatType parametro rappresenta un ICustomFormatter tipo. In caso affermativo, MyFormatter restituisce un'istanza di se stessa; in caso contrario, restituisce null. L'implementazione ICustomFormatter.Format determina se il parametro di formato è una delle tre stringhe di formato supportate ("B" per binary, "O" per ottale e "H" per esadecimale) e formatta il arg parametro in modo appropriato. In caso contrario, se arg non nullè , chiama l'implementazione arg del IFormattable.ToString parametro, se esistente o il relativo metodo senza ToString parametri, se non ne esiste uno. Se arg è null, il metodo restituisce String.Empty.
using System;
using System.Globalization;
using System.Numerics;
public class MyFormatter : IFormatProvider, ICustomFormatter
{
// IFormatProvider.GetFormat implementation.
public object GetFormat(Type formatType)
{
// Determine whether custom formatting object is requested.
if (formatType == typeof(ICustomFormatter))
return this;
else
return null;
}
// Format number in binary (B), octal (O), or hexadecimal (H).
public string Format(string format, object arg, IFormatProvider formatProvider)
{
// Handle format string.
int baseNumber;
// Handle null or empty format string, string with precision specifier.
string thisFmt = String.Empty;
// Extract first character of format string (precision specifiers
// are not supported).
if (!String.IsNullOrEmpty(format))
thisFmt = format.Length > 1 ? format.Substring(0, 1) : format;
// Get a byte array representing the numeric value.
byte[] bytes;
if (arg is sbyte)
{
string byteString = ((sbyte)arg).ToString("X2");
bytes = new byte[1] { Byte.Parse(byteString, System.Globalization.NumberStyles.HexNumber) };
}
else if (arg is byte)
{
bytes = new byte[1] { (byte)arg };
}
else if (arg is short)
{
bytes = BitConverter.GetBytes((short)arg);
}
else if (arg is int)
{
bytes = BitConverter.GetBytes((int)arg);
}
else if (arg is long)
{
bytes = BitConverter.GetBytes((long)arg);
}
else if (arg is ushort)
{
bytes = BitConverter.GetBytes((ushort)arg);
}
else if (arg is uint)
{
bytes = BitConverter.GetBytes((uint)arg);
}
else if (arg is ulong)
{
bytes = BitConverter.GetBytes((ulong)arg);
}
else if (arg is BigInteger)
{
bytes = ((BigInteger)arg).ToByteArray();
}
else
{
try
{
return HandleOtherFormats(format, arg);
}
catch (FormatException e)
{
throw new FormatException(String.Format("The format of '{0}' is invalid.", format), e);
}
}
switch (thisFmt.ToUpper())
{
// Binary formatting.
case "B":
baseNumber = 2;
break;
case "O":
baseNumber = 8;
break;
case "H":
baseNumber = 16;
break;
// Handle unsupported format strings.
default:
try
{
return HandleOtherFormats(format, arg);
}
catch (FormatException e)
{
throw new FormatException(String.Format("The format of '{0}' is invalid.", format), e);
}
}
// Return a formatted string.
string numericString = String.Empty;
for (int ctr = bytes.GetUpperBound(0); ctr >= bytes.GetLowerBound(0); ctr--)
{
string byteString = Convert.ToString(bytes[ctr], baseNumber);
if (baseNumber == 2)
byteString = new String('0', 8 - byteString.Length) + byteString;
else if (baseNumber == 8)
byteString = new String('0', 4 - byteString.Length) + byteString;
// Base is 16.
else
byteString = new String('0', 2 - byteString.Length) + byteString;
numericString += byteString + " ";
}
return numericString.Trim();
}
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
open System.Numerics
type MyFormatter() =
interface IFormatProvider with
// IFormatProvider.GetFormat implementation.
member this.GetFormat(formatType: Type) =
// Determine whether custom formatting object is requested.
if formatType = typeof<ICustomFormatter> then
this
else
null
interface ICustomFormatter with
// Format number in binary (B), octal (O), or hexadecimal (H).
member this.Format(format, arg: obj, formatProvider: IFormatProvider) =
// Handle null or empty format string, string with precision specifier.
let thisFmt =
// Extract first character of format string (precision specifiers
// are not supported).
if String.IsNullOrEmpty format |> not then
if format.Length > 1 then
format.Substring(0, 1)
else
format
else
String.Empty
// Get a byte array representing the numeric value.
let bytes =
match arg with
| :? sbyte as arg ->
let byteString = arg.ToString "X2"
Some [| Byte.Parse(byteString, NumberStyles.HexNumber) |]
| :? byte as arg ->
Some [| arg |]
| :? int16 as arg ->
BitConverter.GetBytes arg
|> Some
| :? int as arg ->
BitConverter.GetBytes arg
|> Some
| :? int64 as arg ->
BitConverter.GetBytes arg
|> Some
| :? uint16 as arg ->
BitConverter.GetBytes arg
|> Some
| :? uint as arg ->
BitConverter.GetBytes arg
|> Some
| :? uint64 as arg ->
BitConverter.GetBytes arg
|> Some
| :? bigint as arg ->
arg.ToByteArray()
|> Some
| _ ->
None
let baseNumber =
match thisFmt.ToUpper() with
// Binary formatting.
| "B" -> Some 2
| "O" -> Some 8
| "H" -> Some 16
// Handle unsupported format strings.
| _ -> None
match bytes, baseNumber with
| Some bytes, Some baseNumber ->
// Return a formatted string.
let mutable numericString = String.Empty
for i = bytes.GetUpperBound 0 to bytes.GetLowerBound 0 do
let byteString = Convert.ToString(bytes[i], baseNumber)
let byteString =
match baseNumber with
| 2 ->
String('0', 8 - byteString.Length) + byteString
| 8 ->
String('0', 4 - byteString.Length) + byteString
// Base is 16.
| _ ->
String('0', 2 - byteString.Length) + byteString
numericString <- numericString + byteString + " "
numericString.Trim()
| _ ->
try
this.HandleOtherFormats(format, arg)
with :? FormatException as e ->
raise (FormatException($"The format of '{format}' is invalid.", e))
member private this.HandleOtherFormats(format, arg: obj) =
match arg with
| :? IFormattable as arg ->
arg.ToString(format, CultureInfo.CurrentCulture)
| null ->
String.Empty
| _ ->
string arg
Imports System.Globalization
Imports System.Numerics
Public Class MyFormatter : Implements IFormatProvider, ICustomFormatter
' IFormatProvider.GetFormat implementation.
Public Function GetFormat(formatType As Type) As Object _
Implements IFormatProvider.GetFormat
' Determine whether custom formatting object is requested.
If formatType Is GetType(ICustomFormatter) Then
Return Me
Else
Return Nothing
End If
End Function
' Format number in binary (B), octal (O), or hexadecimal (H).
Public Function Format(fmt As String, arg As Object, _
formatProvider As IFormatProvider) As String _
Implements ICustomFormatter.Format
' Handle format string.
Dim base As Integer
' Handle null or empty format string, string with precision specifier.
Dim thisFmt As String = String.Empty
' Extract first character of format string (precision specifiers
' are not supported by MyFormatter).
If Not String.IsNullOrEmpty(fmt) Then
thisFmt = CStr(IIf(fmt.Length > 1, fmt.Substring(0, 1), fmt))
End If
' Get a byte array representing the numeric value.
Dim bytes() As Byte
If TypeOf(arg) Is SByte Then
Dim byteString As String = CType(arg, SByte).ToString("X2")
bytes = New Byte(0) { Byte.Parse(byteString, System.Globalization.NumberStyles.HexNumber ) }
ElseIf TypeOf(arg) Is Byte Then
bytes = New Byte(0) { CType(arg, Byte) }
ElseIf TypeOf(arg) Is Int16 Then
bytes = BitConverter.GetBytes(CType(arg, Int16))
ElseIf TypeOf(arg) Is Int32 Then
bytes = BitConverter.GetBytes(CType(arg, Int32))
ElseIf TypeOf(arg) Is Int64 Then
bytes = BitConverter.GetBytes(CType(arg, Int64))
ElseIf TypeOf(arg) Is UInt16 Then
bytes = BitConverter.GetBytes(CType(arg, UInt16))
ElseIf TypeOf(arg) Is UInt32 Then
bytes = BitConverter.GetBytes(CType(arg, UInt64))
ElseIf TypeOf(arg) Is UInt64 Then
bytes = BitConverter.GetBytes(CType(arg, UInt64))
ElseIf TypeOf(arg) Is BigInteger Then
bytes = CType(arg, BigInteger).ToByteArray()
Else
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
Select Case thisFmt.ToUpper()
' Binary formatting.
Case "B"
base = 2
Case "O"
base = 8
Case "H"
base = 16
' Handle unsupported format strings.
Case Else
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 Select
' Return a formatted string.
Dim numericString As String = String.Empty
For ctr As Integer = bytes.GetUpperBound(0) To bytes.GetLowerBound(0) Step -1
Dim byteString As String = Convert.ToString(bytes(ctr), base)
If base = 2 Then
byteString = New String("0"c, 8 - byteString.Length) + byteString
ElseIf base = 8 Then
byteString = New String("0"c, 4 - byteString.Length) + byteString
' Base is 16.
Else
byteString = New String("0"c, 2 - byteString.Length) + byteString
End If
numericString += byteString + " "
Next
Return numericString.Trim()
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
MyFormatter può quindi essere usato per fornire formattazione personalizzata passando un MyFormatter oggetto come provider parametro del Format metodo , come illustrato nell'esempio seguente.
public class Example
{
public static void Main()
{
Console.WindowWidth = 100;
byte byteValue = 124;
Console.WriteLine(String.Format(new MyFormatter(),
"{0} (binary: {0:B}) (hex: {0:H})", byteValue));
int intValue = 23045;
Console.WriteLine(String.Format(new MyFormatter(),
"{0} (binary: {0:B}) (hex: {0:H})", intValue));
ulong ulngValue = 31906574882;
Console.WriteLine(String.Format(new MyFormatter(),
"{0}\n (binary: {0:B})\n (hex: {0:H})",
ulngValue));
BigInteger bigIntValue = BigInteger.Multiply(Int64.MaxValue, 2);
Console.WriteLine(String.Format(new MyFormatter(),
"{0}\n (binary: {0:B})\n (hex: {0:H})",
bigIntValue));
}
}
// The example displays the following output:
// 124 (binary: 01111100) (hex: 7c)
// 23045 (binary: 00000000 00000000 01011010 00000101) (hex: 00 00 5a 05)
// 31906574882
// (binary: 00000000 00000000 00000000 00000111 01101101 11000111 10110010 00100010)
// (hex: 00 00 00 07 6d c7 b2 22)
// 18446744073709551614
// (binary: 00000000 11111111 11111111 11111111 11111111 11111111 11111111 11111111 11111110)
// (hex: 00 ff ff ff ff ff ff ff fe)
Console.WindowWidth <- 100
let byteValue = 124uy
String.Format(MyFormatter(), "{0} (binary: {0:B}) (hex: {0:H})", byteValue)
|> printfn "%s"
let intValue = 23045
String.Format(MyFormatter(), "{0} (binary: {0:B}) (hex: {0:H})", intValue)
|> printfn "%s"
let ulngValue = 31906574882uL
String.Format(MyFormatter(), "{0}\n (binary: {0:B})\n (hex: {0:H})", ulngValue)
|> printfn "%s"
let bigIntValue = BigInteger.Multiply(Int64.MaxValue, 2)
String.Format(MyFormatter(), "{0}\n (binary: {0:B})\n (hex: {0:H})", bigIntValue)
|> printfn "%s"
// The example displays the following output:
// 124 (binary: 01111100) (hex: 7c)
// 23045 (binary: 00000000 00000000 01011010 00000101) (hex: 00 00 5a 05)
// 31906574882
// (binary: 00000000 00000000 00000000 00000111 01101101 11000111 10110010 00100010)
// (hex: 00 00 00 07 6d c7 b2 22)
// 18446744073709551614
// (binary: 00000000 11111111 11111111 11111111 11111111 11111111 11111111 11111111 11111110)
// (hex: 00 ff ff ff ff ff ff ff fe)
Public Module Example
Public Sub Main
Console.WindowWidth = 100
Dim byteValue As Byte = 124
Console.WriteLine(String.Format(New MyFormatter(), _
"{0} (binary: {0:B}) (hex: {0:H})", byteValue))
Dim intValue As Integer = 23045
Console.WriteLine(String.Format(New MyFormatter(), _
"{0} (binary: {0:B}) (hex: {0:H})", intValue))
Dim ulngValue As ULong = 31906574882
Console.WriteLine(String.Format(New MyFormatter(), _
"{0} {1} (binary: {0:B}) {1} (hex: {0:H})", _
ulngValue, vbCrLf))
Dim bigIntValue As BigInteger = BigInteger.Multiply(Int64.MaxValue, 2)
Console.WriteLine(String.Format(New MyFormatter(), _
"{0} {1} (binary: {0:B}) {1} (hex: {0:H})", _
bigIntValue, vbCrLf))
End Sub
End Module
' The example displays the following output:
' 124 (binary: 01111100) (hex: 7c)
' 23045 (binary: 00000000 00000000 01011010 00000101) (hex: 00 00 5a 05)
' 31906574882
' (binary: 00000000 00000000 00000000 00000111 01101101 11000111 10110010 00100010)
' (hex: 00 00 00 07 6d c7 b2 22)
' 18446744073709551614
' (binary: 00000000 11111111 11111111 11111111 11111111 11111111 11111111 11111111 11111110)
' (hex: 00 ff ff ff ff ff ff ff fe)
Commenti
L'interfaccia ICustomFormatter include un singolo metodo, ICustomFormatter.Format. Quando questa interfaccia viene implementata da un tipo riferimento o valore, il Format metodo restituisce una rappresentazione di stringa formattata personalizzata del valore di un oggetto.
In genere, l'interfaccia ICustomFormatter viene implementata con l'interfaccia IFormatProvider per personalizzare il comportamento di due metodi di formattazione composta di stringhe di .NET Framework che includono un parametro IFormatProvider. In particolare, l'interfaccia ICustomFormatter è in grado di fornire una formattazione personalizzata del valore di un oggetto passato ai metodi String.Format(IFormatProvider, String, Object[]) e StringBuilder.AppendFormat(IFormatProvider, String, Object[]).
Per fornire una rappresentazione personalizzata del valore di un oggetto, è necessario eseguire le operazioni seguenti:
Definire una classe che implementa l'interfaccia ICustomFormatter e il relativo singolo membro, ovvero il Format metodo .
Definire una classe che implementa l'interfaccia IFormatProvider e il relativo singolo membro, ovvero il GetFormat metodo . Il GetFormat metodo restituisce un'istanza dell'implementazione ICustomFormatter . Spesso, una singola classe implementa sia che ICustomFormatterIFormatProvider. In tal caso, l'implementazione della
GetFormatclasse restituisce solo un'istanza di se stessa.Passare l'implementazione IFormatProvider come
providerargomento del String.Format(IFormatProvider, String, Object[]) metodo o di un metodo paragonabile.
Il metodo della libreria .NET userà quindi la formattazione personalizzata anziché la propria.
Note per gli implementatori
Common Language Runtime tenta di usare l'implementazione ICustomFormatter per ogni elemento di formato in una stringa di formato composito. Di conseguenza, è necessario prevedere che ICustomFormatter l'implementazione venga chiamata per fornire servizi di formattazione a oggetti o valori che non è progettato per gestire. In questi casi, il Format(String, Object, IFormatProvider) metodo deve chiamare il metodo di formattazione appropriato per tale oggetto o valore.
Esistono due tipi di ICustomFormatter implementazioni: intrinseche ed estensioni.
Le implementazioni intrinseche sono implementazioni che forniscono formattazione personalizzata per un oggetto definito dall'applicazione. In questo caso, l'implementazione deve includere quanto segue:
Definizione di stringhe di formato che definiscono la formattazione dell'oggetto. Le stringhe di formato sono facoltative. In genere, una stringa di formato "G" o "g" definisce il formato generale (o più comunemente usato). Tuttavia, è possibile definire qualsiasi stringa di formato scelta. È anche possibile decidere se fanno distinzione tra maiuscole e minuscole o senza distinzione tra maiuscole e minuscole.
Test per assicurarsi che il tipo dell'oggetto passato al Format(String, Object, IFormatProvider) metodo sia il tipo definito dall'applicazione. In caso contrario, è necessario chiamare l'implementazione dell'oggetto IFormattable , se presente o il relativo ToString() metodo, in caso contrario. È consigliabile essere pronti a gestire eventuali eccezioni che queste chiamate al metodo potrebbero generare.
Codice per gestire una stringa di formato Null, se l'implementazione supporta stringhe di formato. L'approccio più comune consiste nel sostituire una stringa di formato Null con l'identificatore di formato generale.
Codice per gestire tutte le stringhe di formato supportate dall'implementazione.
Codice per gestire le stringhe di formato non supportate. L'approccio più comune consiste nell'generare un FormatException, anche se è possibile fornire la formattazione predefinita.
Le implementazioni di estensione sono implementazioni che forniscono formattazione personalizzata per un tipo che dispone già del supporto per la formattazione. Ad esempio, è possibile definire un oggetto CustomerNumberFormatter che formatta un tipo integrale con trattini tra cifre specifiche. In questo caso, l'implementazione deve includere quanto segue:
Definizione di stringhe di formato che estendono la formattazione dell'oggetto. Queste stringhe di formato sono obbligatorie, ma non devono essere in conflitto con le stringhe di formato esistenti del tipo. Ad esempio, se si estende la formattazione per il Int32 tipo, non è consigliabile implementare gli identificatori di formato "C", "D", "E", "F" e "G".
Un test che il tipo dell'oggetto passato al Format(String, Object, IFormatProvider) metodo è un tipo la cui formattazione supporta l'estensione. In caso contrario, chiamare l'implementazione dell'oggetto IFormattable , se esistente o il metodo senza ToString() parametri dell'oggetto, in caso contrario. È consigliabile essere pronti a gestire eventuali eccezioni che queste chiamate al metodo potrebbero generare.
Codice per gestire tutte le stringhe di formato supportate dall'estensione.
Codice per gestire tutte le stringhe di formato non supportate dall'estensione. Questi elementi devono essere passati all'implementazione del IFormattable tipo. È consigliabile essere pronti a gestire eventuali eccezioni che queste chiamate al metodo potrebbero generare.
Metodi
| Format(String, Object, IFormatProvider) |
Converte il valore di un oggetto specificato in una rappresentazione di stringa equivalente usando il formato e le informazioni di formattazione specifiche delle impostazioni cultura indicati. |
