IConvertible Interface

Définition

Espace de noms:

System

Assemblys:

netstandard.dll, System.Runtime.dll

Source:

IConvertible.cs

Important

Cette API n’est pas conforme CLS.

Définit des méthodes qui convertissent la valeur de la référence ou du type valeur d’implémentation en type Common Language Runtime qui a une valeur équivalente.

public interface class IConvertible

[System.CLSCompliant(false)]
public interface IConvertible

[<System.CLSCompliant(false)>]
type IConvertible = interface

Public Interface IConvertible

Dérivé

System.Boolean

System.Byte

System.Char

System.DateTime

System.DBNull

System.Decimal

System.Double

System.Enum

System.Int16

System.Int32

System.Int64

System.SByte

System.Single

System.String

System.UInt16

System.UInt32

System.UInt64

Attributs

CLSCompliantAttribute

Exemples

L’exemple de code suivant illustre une implémentation d’une IConvertible classe de nombres complexes, ce qui lui permet d’être casté en premier en tant que Double membre statique, puis d’appeler les membres statiques Convert sur ce Double.

using System;

namespace ConsoleApplication2
{

    /// Class that implements IConvertible
    class Complex : IConvertible
    {
        double	x;
        double	y;

        public Complex(double x, double y)
        {
            this.x = x;
            this.y = y;
        }

        public TypeCode GetTypeCode()
        {
            return TypeCode.Object;
        }

        bool IConvertible.ToBoolean(IFormatProvider provider)
        {
            if(	(x != 0.0) || (y != 0.0) )
                return true;
            else
                return false;
        }

        double GetDoubleValue()
        {
            return Math.Sqrt(x*x + y*y);
        }

        byte IConvertible.ToByte(IFormatProvider provider)
        {
            return Convert.ToByte(GetDoubleValue());
        }

        char IConvertible.ToChar(IFormatProvider provider)
        {
            return Convert.ToChar(GetDoubleValue());
        }

        DateTime IConvertible.ToDateTime(IFormatProvider provider)
        {
            return Convert.ToDateTime(GetDoubleValue());
        }

        decimal IConvertible.ToDecimal(IFormatProvider provider)
        {
            return Convert.ToDecimal(GetDoubleValue());
        }

        double IConvertible.ToDouble(IFormatProvider provider)
        {
            return GetDoubleValue();
        }

        short IConvertible.ToInt16(IFormatProvider provider)
        {
            return Convert.ToInt16(GetDoubleValue());
        }

        int IConvertible.ToInt32(IFormatProvider provider)
        {
            return Convert.ToInt32(GetDoubleValue());
        }

        long IConvertible.ToInt64(IFormatProvider provider)
        {
            return Convert.ToInt64(GetDoubleValue());
        }

        sbyte IConvertible.ToSByte(IFormatProvider provider)
        {
            return Convert.ToSByte(GetDoubleValue());
        }

        float IConvertible.ToSingle(IFormatProvider provider)
        {
            return Convert.ToSingle(GetDoubleValue());
        }

        string IConvertible.ToString(IFormatProvider provider)
        {
            return String.Format("({0}, {1})", x, y);
        }

        object IConvertible.ToType(Type conversionType, IFormatProvider provider)
        {
            return Convert.ChangeType(GetDoubleValue(),conversionType);
        }

        ushort IConvertible.ToUInt16(IFormatProvider provider)
        {
            return Convert.ToUInt16(GetDoubleValue());
        }

        uint IConvertible.ToUInt32(IFormatProvider provider)
        {
            return Convert.ToUInt32(GetDoubleValue());
        }

        ulong IConvertible.ToUInt64(IFormatProvider provider)
        {
            return Convert.ToUInt64(GetDoubleValue());
        }
    }

    /// <summary>
    /// Summary description for Class1.
    /// </summary>
    class Class1
    {
        static void Main(string[] args)
        {

            Complex		testComplex = new Complex(4,7);

            WriteObjectInfo(testComplex);
            WriteObjectInfo(Convert.ToBoolean(testComplex));
            WriteObjectInfo(Convert.ToDecimal(testComplex));
            WriteObjectInfo(Convert.ToString(testComplex));
        }

        static void WriteObjectInfo(object testObject)
        {
            TypeCode	typeCode = Type.GetTypeCode( testObject.GetType() );

            switch( typeCode )
            {
                case TypeCode.Boolean:
                    Console.WriteLine("Boolean: {0}", testObject);
                    break;

                case TypeCode.Double:
                    Console.WriteLine("Double: {0}", testObject);
                    break;
                                
                default:
                    Console.WriteLine("{0}: {1}", typeCode.ToString(), testObject);
                    break;
            }
        }
    }
}

open System

/// Class that implements IConvertible
type Complex(x, y) =
    member _.GetDoubleValue() =
        sqrt (x * x + y * y)
 
    interface IConvertible with
        member _.GetTypeCode() =
            TypeCode.Object

        member _.ToBoolean(provider: IFormatProvider) =
            (x <> 0.) || (y <> 0.)

        member this.ToByte(provider: IFormatProvider) =
            Convert.ToByte(this.GetDoubleValue())

        member this.ToChar(provider: IFormatProvider) =
            Convert.ToChar(this.GetDoubleValue())

        member this.ToDateTime(provider: IFormatProvider) =
            Convert.ToDateTime(this.GetDoubleValue())

        member this.ToDecimal(provider: IFormatProvider) =
            Convert.ToDecimal(this.GetDoubleValue())

        member this.ToDouble(provider: IFormatProvider) =
            this.GetDoubleValue()

        member this.ToInt16(provider: IFormatProvider) =
            Convert.ToInt16(this.GetDoubleValue())

        member this.ToInt32(provider: IFormatProvider) =
            Convert.ToInt32(this.GetDoubleValue())

        member this.ToInt64(provider: IFormatProvider) =
            Convert.ToInt64(this.GetDoubleValue())

        member this.ToSByte(provider: IFormatProvider) =
            Convert.ToSByte(this.GetDoubleValue())

        member this.ToSingle(provider: IFormatProvider) =
            Convert.ToSingle(this.GetDoubleValue())

        member _.ToString(provider: IFormatProvider) =
            $"({x}, {y})"

        member this.ToType(conversionType: Type, provider: IFormatProvider) =
            Convert.ChangeType(this.GetDoubleValue(), conversionType)

        member this.ToUInt16(provider: IFormatProvider) =
            Convert.ToUInt16(this.GetDoubleValue())

        member this.ToUInt32(provider: IFormatProvider) =
            Convert.ToUInt32(this.GetDoubleValue())

        member this.ToUInt64(provider: IFormatProvider) =
            Convert.ToUInt64(this.GetDoubleValue())

let writeObjectInfo testObject =
    let typeCode = Type.GetTypeCode(testObject.GetType())
    match typeCode with
    | TypeCode.Boolean ->
        printfn $"Boolean: {testObject}"
    | TypeCode.Double ->
        printfn $"Boolean: {testObject}"
    | _ ->
        printfn $"{typeCode}: {testObject}"

let testComplex = Complex(4, 7)

writeObjectInfo testComplex
writeObjectInfo (Convert.ToBoolean testComplex)
writeObjectInfo (Convert.ToDecimal testComplex)
writeObjectInfo (Convert.ToString testComplex)

Public Class Complex : Implements IConvertible
   Private x, y As Double

   Public Sub New(ByVal x As Double, ByVal y As Double)
      Me.x = x
      Me.y = y
   End Sub

   Function GetDoubleValue() As Double
      Return Math.Sqrt((x * x + y * y))
   End Function

   ' The remaining code provides IConvertible method implementations.
   Public Function GetTypeCode() As TypeCode Implements IConvertible.GetTypeCode
      Return TypeCode.Object
   End Function

   Function ToBoolean(ByVal provider As IFormatProvider) As Boolean _
            Implements IConvertible.ToBoolean
      Return x <> 0 OrElse y <> 0
   End Function

   Function ToByte(ByVal provider As IFormatProvider) As Byte Implements IConvertible.ToByte
       Return Convert.ToByte(GetDoubleValue())
   End Function

   Function ToChar(ByVal provider As IFormatProvider) As Char Implements IConvertible.ToChar
      Return Convert.ToChar(GetDoubleValue())
   End Function

   Function ToDateTime(ByVal provider As IFormatProvider) As DateTime Implements IConvertible.ToDateTime
      Return Convert.ToDateTime(GetDoubleValue())
   End Function

   Function ToDecimal(ByVal provider As IFormatProvider) As Decimal Implements IConvertible.ToDecimal
      Return Convert.ToDecimal(GetDoubleValue())
   End Function

   Function ToDouble(ByVal provider As IFormatProvider) As Double Implements IConvertible.ToDouble
      Return GetDoubleValue()
   End Function

   Function ToInt16(ByVal provider As IFormatProvider) As Short Implements IConvertible.ToInt16
      Return Convert.ToInt16(GetDoubleValue())
   End Function

   Function ToInt32(ByVal provider As IFormatProvider) As Integer Implements IConvertible.ToInt32
      Return Convert.ToInt32(GetDoubleValue())
   End Function

   Function ToInt64(ByVal provider As IFormatProvider) As Long Implements IConvertible.ToInt64
      Return Convert.ToInt64(GetDoubleValue())
   End Function

   Function ToSByte(ByVal provider As IFormatProvider) As SByte Implements IConvertible.ToSByte
      Return Convert.ToSByte(GetDoubleValue())
   End Function

   Function ToSingle(ByVal provider As IFormatProvider) As Single Implements IConvertible.ToSingle
      Return Convert.ToSingle(GetDoubleValue())
   End Function

   Overloads Function ToString(ByVal provider As IFormatProvider) As String Implements IConvertible.ToString
      Return String.Format("({0}, {1})", x, y)
   End Function

   Function ToType(ByVal conversionType As Type, ByVal provider As IFormatProvider) As Object Implements IConvertible.ToType
      Return Convert.ChangeType(GetDoubleValue(), conversionType)
   End Function

   Function ToUInt16(ByVal provider As IFormatProvider) As UInt16 Implements IConvertible.ToUInt16
      Return Convert.ToUInt16(GetDoubleValue())
   End Function

   Function ToUInt32(ByVal provider As IFormatProvider) As UInt32 Implements IConvertible.ToUInt32
      Return Convert.ToUInt32(GetDoubleValue())
   End Function

   Function ToUInt64(ByVal provider As IFormatProvider) As UInt64 Implements IConvertible.ToUInt64
      Return Convert.ToUInt64(GetDoubleValue())
   End Function
End Class

Public Module Example
   Sub Main()
      Dim testComplex As New Complex(4, 7)

      WriteObjectInfo(testComplex)
      WriteObjectInfo(Convert.ToBoolean(testComplex))
      WriteObjectInfo(Convert.ToDecimal(testComplex))
      WriteObjectInfo(Convert.ToString(testComplex))
   End Sub

   Sub WriteObjectInfo(ByVal testObject As Object)
      Dim typeCode As TypeCode = Type.GetTypeCode(testObject.GetType())

      Select Case typeCode
         Case typeCode.Boolean
            Console.WriteLine("Boolean: {0}", testObject)

         Case typeCode.Double
            Console.WriteLine("Double: {0}", testObject)

         Case Else
            Console.WriteLine("{0}: {1}", typeCode.ToString(), testObject)
      End Select
   End Sub
End Module

Remarques

Cette interface fournit des méthodes pour convertir la valeur d’une instance d’un type d’implémentation en type Common Language Runtime qui a une valeur équivalente. Les types common language runtime sont Boolean, , ByteSByte, Int16UInt32UInt16Int32UInt64Int64, , Single, Double, Decimal, DateTimeChar, et .String

S’il n’existe aucune conversion significative vers un type Common Language Runtime, une implémentation de méthode d’interface particulière lève InvalidCastException. Par exemple, si cette interface est implémentée sur un type booléen, l’implémentation de la ToDateTime méthode lève une exception, car il n’existe pas d’équivalent significatif DateTime à un type booléen.

Le Common Language Runtime expose généralement l’interface IConvertible via la Convert classe. Le Common Language Runtime utilise également l’interface IConvertible en interne, dans les implémentations d’interface explicites, pour simplifier le code utilisé pour prendre en charge les conversions dans les types Common Language Runtime de base et de Convert classe.

Outre l’interface IConvertible, .NET fournit des classes appelées convertisseurs type pour convertir des types de données définis par l’utilisateur en d’autres types de données.

Notes pour les responsables de l’implémentation

Si vous implémentez l’interface IConvertible , votre implémentation est appelée automatiquement par la ChangeType(Object, Type) méthode si le Object paramètre est une instance de votre type d’implémentation et que le Type paramètre est un type Common Language Runtime.

La plupart des méthodes de conversion ont un paramètre de type IFormatProvider qui représente la culture actuelle (CurrentCulture) ou une culture spécifique. Pour la plupart, les IConvertible implémentations des types de base ignorent ce paramètre. Toutefois, vous pouvez choisir de l’utiliser dans votre code.

Méthodes

Nom	Description
GetTypeCode()	Retourne la TypeCode valeur de cette instance.
ToBoolean(IFormatProvider)	Convertit la valeur de cette instance en valeur booléenne équivalente à l’aide des informations de mise en forme spécifiques à la culture spécifiées.
ToByte(IFormatProvider)	Convertit la valeur de cette instance en entier non signé 8 bits équivalent à l’aide des informations de mise en forme spécifiques à la culture spécifiées.
ToChar(IFormatProvider)	Convertit la valeur de cette instance en caractère Unicode équivalent à l’aide des informations de mise en forme spécifiques à la culture spécifiées.
ToDateTime(IFormatProvider)	Convertit la valeur de cette instance en équivalent DateTime à l’aide des informations de mise en forme spécifiques à la culture spécifiées.
ToDecimal(IFormatProvider)	Convertit la valeur de cette instance en nombre équivalent Decimal à l’aide des informations de mise en forme spécifiques à la culture spécifiées.
ToDouble(IFormatProvider)	Convertit la valeur de cette instance en nombre à virgule flottante double précision équivalent à l’aide des informations de mise en forme spécifiques à la culture spécifiées.
ToInt16(IFormatProvider)	Convertit la valeur de cette instance en entier signé 16 bits équivalent à l’aide des informations de mise en forme spécifiques à la culture spécifiées.
ToInt32(IFormatProvider)	Convertit la valeur de cette instance en entier signé 32 bits équivalent à l’aide des informations de mise en forme spécifiques à la culture spécifiées.
ToInt64(IFormatProvider)	Convertit la valeur de cette instance en entier signé 64 bits équivalent à l’aide des informations de mise en forme spécifiques à la culture spécifiées.
ToSByte(IFormatProvider)	Convertit la valeur de cette instance en entier signé 8 bits équivalent à l’aide des informations de mise en forme spécifiques à la culture spécifiées.
ToSingle(IFormatProvider)	Convertit la valeur de cette instance en nombre à virgule flottante simple précision équivalent à l’aide des informations de mise en forme spécifiques à la culture spécifiées.
ToString(IFormatProvider)	Convertit la valeur de cette instance en équivalent String à l’aide des informations de mise en forme spécifiques à la culture spécifiées.
ToType(Type, IFormatProvider)	Convertit la valeur de cette instance en une Object valeur équivalente, à l’aide Type des informations de mise en forme spécifiques à la culture spécifiées.
ToUInt16(IFormatProvider)	Convertit la valeur de cette instance en entier non signé 16 bits équivalent à l’aide des informations de mise en forme spécifiques à la culture spécifiées.
ToUInt32(IFormatProvider)	Convertit la valeur de cette instance en entier non signé 32 bits équivalent à l’aide des informations de mise en forme spécifiques à la culture spécifiées.
ToUInt64(IFormatProvider)	Convertit la valeur de cette instance en entier non signé 64 bits équivalent à l’aide des informations de mise en forme spécifiques à la culture spécifiées.

Voir aussi

• conversion Type dans .NET Framework