IConvertible Interface

Definitie

Belangrijk

Deze API is niet CLS-conform.

Definieert methoden waarmee de waarde van het implementatiereferentie- of waardetype wordt geconverteerd naar een common language runtime-type met een equivalente waarde.

public interface class IConvertible
[System.CLSCompliant(false)]
public interface IConvertible
[System.CLSCompliant(false)]
[System.Runtime.InteropServices.ComVisible(true)]
public interface IConvertible
[<System.CLSCompliant(false)>]
type IConvertible = interface
[<System.CLSCompliant(false)>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type IConvertible = interface
Public Interface IConvertible
Afgeleid
Kenmerken

Voorbeelden

Het volgende codevoorbeeld demonstreert een implementatie van IConvertible voor een complexe getalklasse, zodat deze eerst kan worden gecast als een Double en vervolgens de statische Convert leden daarop Doubleaanroept.

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

Opmerkingen

Deze interface biedt methoden voor het converteren van de waarde van een exemplaar van een implementatietype naar een algemeen runtimetype voor talen met een equivalente waarde. De algemene typen taalruntime zijn Boolean, , SByte, Byte, Int16UInt16, Int32, , UInt32Int64UInt64SingleDoubleDecimalDateTime, , en .CharString

Als er geen zinvolle conversie naar een gemeenschappelijk runtimetype voor taal is, genereert InvalidCastExceptioneen bepaalde interfacemethodeimplementatie. Als deze interface bijvoorbeeld is geïmplementeerd op een Boole-type, genereert de implementatie van de ToDateTime methode een uitzondering omdat er geen betekenisvol DateTime equivalent is aan een Boole-type.

De algemene taalruntime maakt de IConvertible interface doorgaans beschikbaar via de Convert klasse. De algemene taalruntime maakt ook intern gebruik van de IConvertible interface, in expliciete interface-implementaties, om de code te vereenvoudigen die wordt gebruikt ter ondersteuning van conversies in de Convert klasse en algemene runtimetypen voor talen.

Naast de interface IConvertible biedt het .NET Framework klassen genaamd typeconversieprogramma's voor het converteren van door de gebruiker gedefinieerde gegevenstypen naar andere gegevenstypen. Zie het onderwerp Gegeneraliseerde typeconversie voor meer informatie.

Notities voor uitvoerders

Als u de IConvertible interface implementeert, wordt uw implementatie automatisch aangeroepen door de ChangeType(Object, Type) methode als de Object parameter een exemplaar van uw implementatietype is en de Type parameter een algemeen runtimetype voor de taal is.

De meeste conversiemethoden hebben een parameter van het type IFormatProvider die de huidige cultuur (CurrentCulture) of een specifieke cultuur vertegenwoordigt. Voor het grootste deel negeren de IConvertible implementaties van de basistypen deze parameter. U kunt echter kiezen of u deze wilt gebruiken in uw code.

Methoden

Name Description
GetTypeCode()

Retourneert het TypeCode voor dit exemplaar.

ToBoolean(IFormatProvider)

Converteert de waarde van dit exemplaar naar een equivalente Booleaanse waarde met behulp van de opgegeven cultuurspecifieke opmaakinformatie.

ToByte(IFormatProvider)

Converteert de waarde van dit exemplaar naar een equivalent 8-bits geheel getal zonder teken met behulp van de opgegeven cultuurspecifieke opmaakinformatie.

ToChar(IFormatProvider)

Converteert de waarde van dit exemplaar naar een equivalent Unicode-teken met behulp van de opgegeven cultuurspecifieke opmaakgegevens.

ToDateTime(IFormatProvider)

Converteert de waarde van dit exemplaar naar een equivalent DateTime met behulp van de opgegeven cultuurspecifieke opmaakinformatie.

ToDecimal(IFormatProvider)

Converteert de waarde van dit exemplaar naar een equivalent Decimal getal met behulp van de opgegeven cultuurspecifieke opmaakinformatie.

ToDouble(IFormatProvider)

Converteert de waarde van dit exemplaar naar een equivalent drijvendekommagetal met dubbele precisie met behulp van de opgegeven cultuurspecifieke opmaakinformatie.

ToInt16(IFormatProvider)

Converteert de waarde van dit exemplaar naar een equivalent 16-bits geheel getal dat is ondertekend met behulp van de opgegeven cultuurspecifieke opmaakinformatie.

ToInt32(IFormatProvider)

Converteert de waarde van dit exemplaar naar een equivalent 32-bits geheel getal dat is ondertekend met behulp van de opgegeven cultuurspecifieke opmaakgegevens.

ToInt64(IFormatProvider)

Converteert de waarde van dit exemplaar naar een equivalent 64-bits geheel getal dat is ondertekend met behulp van de opgegeven cultuurspecifieke opmaakinformatie.

ToSByte(IFormatProvider)

Converteert de waarde van dit exemplaar naar een equivalent 8-bits geheel getal dat is ondertekend met behulp van de opgegeven cultuurspecifieke opmaakinformatie.

ToSingle(IFormatProvider)

Converteert de waarde van dit exemplaar naar een equivalent drijvendekommagetal met één precisie met behulp van de opgegeven cultuurspecifieke opmaakinformatie.

ToString(IFormatProvider)

Converteert de waarde van dit exemplaar naar een equivalent String met behulp van de opgegeven cultuurspecifieke opmaakinformatie.

ToType(Type, IFormatProvider)

Converteert de waarde van dit exemplaar naar een Object van de opgegeven Type waarden met een equivalente waarde, met behulp van de opgegeven cultuurspecifieke opmaakgegevens.

ToUInt16(IFormatProvider)

Converteert de waarde van dit exemplaar naar een equivalent 16-bits geheel getal zonder teken met behulp van de opgegeven cultuurspecifieke opmaakinformatie.

ToUInt32(IFormatProvider)

Converteert de waarde van dit exemplaar naar een equivalent 32-bits geheel getal zonder teken met behulp van de opgegeven cultuurspecifieke opmaakinformatie.

ToUInt64(IFormatProvider)

Converteert de waarde van dit exemplaar naar een equivalent 64-bits geheel getal zonder teken met behulp van de opgegeven cultuurspecifieke opmaakinformatie.

Van toepassing op

Zie ook