ICustomFormatter Interface

Définition

Espace de noms:

System

Assemblys:

netstandard.dll, System.Runtime.dll

Définit une méthode qui prend en charge la mise en forme personnalisée de la valeur d'un objet.

C#

public interface ICustomFormatter

Dérivé

System.CommandLine.Rendering.TextSpanFormatter

Exemples

L’exemple suivant implémente pour autoriser la mise en forme binaire, octale et hexadécimale des valeurs intégrales ICustomFormatter . Dans cet exemple, une classe unique, MyFormatter, implémente à la fois ICustomFormatter et IFormatProvider. Sa IFormatProvider.GetFormat méthode détermine si le formatType paramètre représente un ICustomFormatter type. Si c’est le cas, MyFormatter retourne une instance d’elle-même ; sinon, elle retourne null. Son ICustomFormatter.Format implémentation détermine si le paramètre de format est l’une des trois chaînes de format prises en charge (« B » pour binaire, « O » pour octal et « H » pour hexadécimal) et met en forme le arg paramètre de manière appropriée. Sinon, si arg n’est pas null, il appelle l’implémentation arg du IFormattable.ToString paramètre, le cas échéant, ou sa méthode sans ToString paramètre, si elle n’en est pas une. Si arg est null, la méthode retourne String.Empty.

C#

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;
    }
}

MyFormatter peut ensuite être utilisé pour fournir une mise en forme personnalisée en passant un MyFormatter objet comme provider paramètre de la Format méthode, comme le montre l’exemple suivant.

C#

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)

Remarques

L’interface ICustomFormatter inclut une seule méthode, ICustomFormatter.Format. Lorsque cette interface est implémentée par un type de référence ou de valeur, la Format méthode retourne une représentation sous forme de chaîne personnalisée de la valeur d’un objet.

En règle générale, l’interface ICustomFormatter est implémentée avec l’interface IFormatProvider pour personnaliser le comportement de deux méthodes de mise en forme de chaîne composite .NET Framework qui incluent un IFormatProvider paramètre. Plus précisément, l’interface ICustomFormatter peut fournir une mise en forme personnalisée de la valeur d’un objet passé aux String.Format(IFormatProvider, String, Object[]) méthodes et StringBuilder.AppendFormat(IFormatProvider, String, Object[]) .

Pour fournir une représentation personnalisée de la valeur d’un objet, vous devez effectuer les opérations suivantes :

1. Définissez une classe qui implémente l’interface ICustomFormatter et son membre unique, la Format méthode .

2. Définissez une classe qui implémente l’interface IFormatProvider et son membre unique, la GetFormat méthode . La GetFormat méthode retourne une instance de votre ICustomFormatter implémentation. Souvent, une seule classe implémente à la fois ICustomFormatter et IFormatProvider. Dans ce cas, l’implémentation de GetFormat la classe retourne simplement une instance d’elle-même.

3. Passez l’implémentation IFormatProvider comme provider argument de la String.Format(IFormatProvider, String, Object[]) méthode ou d’une méthode comparable.

La méthode de bibliothèque .NET utilise ensuite votre mise en forme personnalisée au lieu de sa propre mise en forme.

Notes pour les responsables de l’implémentation

Le Common Language Runtime tente d’utiliser votre ICustomFormatter implémentation pour chaque élément de format d’une chaîne de format composite. Par conséquent, vous devez vous attendre à ce que votre ICustomFormatter implémentation soit appelée pour fournir des services de mise en forme à des objets ou des valeurs qu’elle n’est pas conçue pour gérer. Dans ce cas, votre Format(String, Object, IFormatProvider) méthode doit appeler la méthode de mise en forme appropriée pour cet objet ou cette valeur.

Il existe deux types d’implémentations ICustomFormatter : intrinsèque et extension.

Les implémentations intrinsèques sont des implémentations qui fournissent une mise en forme personnalisée pour un objet défini par l’application. Dans ce cas, votre implémentation doit inclure les éléments suivants :

• Définition de chaînes de format qui définissent la mise en forme de l’objet. Les chaînes de format sont facultatives. En règle générale, une chaîne de format « G » ou « g » définit le format général (ou le plus couramment utilisé). Toutefois, vous êtes libre de définir les chaînes de format de votre choix. Vous êtes également libre de décider s’ils respectent la casse ou ne respectent pas la casse.

• Test pour vérifier que le type de l’objet passé à votre Format(String, Object, IFormatProvider) méthode est votre type défini par l’application. Si ce n’est pas le cas, vous devez appeler l’implémentation de IFormattable l’objet, le cas échéant, ou sa ToString() méthode, si ce n’est pas le cas. Vous devez être prêt à gérer les exceptions que ces appels de méthode peuvent lever.

• Code pour gérer une chaîne de format null, si votre implémentation prend en charge les chaînes de format. L’approche la plus courante consiste à remplacer une chaîne de format Null par le spécificateur de format général.

• Code pour gérer toutes les chaînes de format que votre implémentation prend en charge.

• Code pour gérer les chaînes de format que vous ne prenez pas en charge. L’approche la plus courante consiste à lever un FormatException, bien que vous puissiez fournir une mise en forme par défaut.

Les implémentations d’extension sont des implémentations qui fournissent une mise en forme personnalisée pour un type qui prend déjà en charge la mise en forme. Par exemple, vous pouvez définir un CustomerNumberFormatter qui met en forme un type intégral avec des traits d’union entre des chiffres spécifiques. Dans ce cas, votre implémentation doit inclure les éléments suivants :

• Définition de chaînes de format qui étendent la mise en forme de l’objet. Ces chaînes de format sont obligatoires, mais elles ne doivent pas entrer en conflit avec les chaînes de format existantes du type. Par exemple, si vous étendez la mise en forme pour le Int32 type, vous ne devez pas implémenter les spécificateurs de format « C », « D », « E », « F » et « G », entre autres.

• Test indiquant que le type de l’objet passé à votre Format(String, Object, IFormatProvider) méthode est un type dont la mise en forme est prise en charge par votre extension. Si ce n’est pas le cas, appelez l’implémentation de IFormattable l’objet, le cas échéant, ou la méthode sans ToString() paramètre de l’objet, si ce n’est pas le cas. Vous devez être prêt à gérer les exceptions que ces appels de méthode peuvent lever.

• Code pour gérer toutes les chaînes de format que votre extension prend en charge.

• Code pour gérer les chaînes de format que votre extension ne prend pas en charge. Celles-ci doivent être transmises à l’implémentation du IFormattable type. Vous devez être prêt à gérer les exceptions que ces appels de méthode peuvent lever.

Méthodes

Format(String, Object, IFormatProvider)

Convertit la valeur d’un objet spécifié en représentation sous forme de chaîne équivalente en utilisant les informations de format et de mise en forme spécifiques à la culture spécifiées.

S’applique à

Voir aussi

• IFormatProvider