Compartir vía


IConvertible Interfaz

Definición

Importante

Esta API no es conforme a CLS.

Define métodos que convierten el valor del tipo de referencia o valor de implementación en un tipo de Common Language Runtime que tiene un valor equivalente.

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
Derivado
Atributos

Ejemplos

En el ejemplo de código siguiente se muestra una implementación de IConvertible para una clase de número complejo, lo que permite convertir primero como Double y, a continuación, llamar a los miembros estáticos Convert en ese 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

Comentarios

Esta interfaz proporciona métodos para convertir el valor de una instancia de un tipo de implementación en un tipo de Common Language Runtime que tiene un valor equivalente. Los tipos de Common Language Runtime son Boolean, SByte, Byte, UInt16Int32Int64UInt64SingleUInt32Int16DecimalDateTimeDoubleChary .String

Si no hay ninguna conversión significativa a un tipo de Common Language Runtime, una implementación de método de InvalidCastExceptioninterfaz determinada produce . Por ejemplo, si esta interfaz se implementa en un tipo booleano, la implementación del ToDateTime método produce una excepción porque no hay ningún equivalente significativo DateTime a un tipo booleano.

Common Language Runtime suele exponer la IConvertible interfaz a través de la Convert clase . Common Language Runtime también usa la IConvertible interfaz internamente, en implementaciones de interfaz explícitas, para simplificar el código usado para admitir conversiones en la Convert clase y los tipos básicos de Common Language Runtime.

Además de la interfaz IConvertible, .NET proporciona clases denominadas convertidores type para convertir tipos de datos definidos por el usuario a otros tipos de datos.

Notas a los implementadores

Si implementa la IConvertible interfaz, el método llamará automáticamente a la ChangeType(Object, Type) implementación si el Object parámetro es una instancia del tipo de implementación y el Type parámetro es un tipo de Common Language Runtime.

La mayoría de los métodos de conversión tienen un parámetro de tipo IFormatProvider que representa la referencia cultural actual (CurrentCulture) o una referencia cultural específica. En la mayor parte, las IConvertible implementaciones de los tipos base omiten este parámetro. Sin embargo, puede elegir si se va a usar en el código.

Métodos

Nombre Description
GetTypeCode()

Devuelve para TypeCode esta instancia.

ToBoolean(IFormatProvider)

Convierte el valor de esta instancia en un valor booleano equivalente mediante la información de formato específica de la referencia cultural especificada.

ToByte(IFormatProvider)

Convierte el valor de esta instancia en un entero de 8 bits sin signo equivalente mediante la información de formato específica de la referencia cultural especificada.

ToChar(IFormatProvider)

Convierte el valor de esta instancia en un carácter Unicode equivalente mediante la información de formato específica de la referencia cultural especificada.

ToDateTime(IFormatProvider)

Convierte el valor de esta instancia en un equivalente DateTime mediante la información de formato específica de la referencia cultural especificada.

ToDecimal(IFormatProvider)

Convierte el valor de esta instancia en un número equivalente Decimal mediante la información de formato específica de la referencia cultural especificada.

ToDouble(IFormatProvider)

Convierte el valor de esta instancia en un número de punto flotante de precisión doble equivalente mediante la información de formato específica de la referencia cultural especificada.

ToInt16(IFormatProvider)

Convierte el valor de esta instancia en un entero de 16 bits con signo equivalente mediante la información de formato específica de la referencia cultural especificada.

ToInt32(IFormatProvider)

Convierte el valor de esta instancia en un entero de 32 bits con signo equivalente mediante la información de formato específica de la referencia cultural especificada.

ToInt64(IFormatProvider)

Convierte el valor de esta instancia en un entero de 64 bits con signo equivalente mediante la información de formato específica de la referencia cultural especificada.

ToSByte(IFormatProvider)

Convierte el valor de esta instancia en un entero de 8 bits con signo equivalente mediante la información de formato específica de la referencia cultural especificada.

ToSingle(IFormatProvider)

Convierte el valor de esta instancia en un número de punto flotante de precisión sencilla equivalente mediante la información de formato específica de la referencia cultural especificada.

ToString(IFormatProvider)

Convierte el valor de esta instancia en un equivalente String mediante la información de formato específica de la referencia cultural especificada.

ToType(Type, IFormatProvider)

Convierte el valor de esta instancia en un Object de especificado Type que tiene un valor equivalente, utilizando la información de formato específica de la referencia cultural especificada.

ToUInt16(IFormatProvider)

Convierte el valor de esta instancia en un entero de 16 bits sin signo equivalente mediante la información de formato específica de la referencia cultural especificada.

ToUInt32(IFormatProvider)

Convierte el valor de esta instancia en un entero de 32 bits sin signo equivalente mediante la información de formato específica de la referencia cultural especificada.

ToUInt64(IFormatProvider)

Convierte el valor de esta instancia en un entero de 64 bits sin signo equivalente mediante la información de formato específica de la referencia cultural especificada.

Se aplica a

Consulte también