IConvertible Interface

Definição

Importante

Esta API não está em conformidade com CLS.

Define métodos que convertem o valor da referência ou do tipo de valor implementado para um tipo de runtime de linguagem comum que tenha um 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

Exemplos

O exemplo de código seguinte demonstra uma implementação de IConvertible para uma classe de números complexos, permitindo que seja lançada primeiro como a Double e depois chamando os membros estáticos Convert nessa 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

Observações

Esta interface fornece métodos para converter o valor de uma instância de um tipo de implementação para um tipo de runtime de linguagem comum que tenha um valor equivalente. Os tipos comuns de runtime da linguagem são Boolean, SByte, Byte, Int16, UInt16Int32, Int64UInt32, UInt64DoubleDecimalDateTimeSingleChare .String

Se não houver conversão significativa para um tipo de runtime de linguagem comum, então uma implementação particular do método interface lança InvalidCastException. Por exemplo, se esta interface for implementada num tipo Booleano, a implementação do ToDateTime método lança uma exceção porque não existe um equivalente significativo DateTime a um tipo Booleano.

O runtime da common language normalmente expõe a IConvertible interface através da Convert classe. O runtime da linguagem comum também utiliza a IConvertible interface internamente, em implementações explícitas de interface, para simplificar o código usado para suportar conversões nos Convert tipos de runtime de classe e linguagem comum básica.

Para além da interface IConvertible, .NET Framework fornece classes chamadas conversores de tipos para converter tipos de dados definidos pelo utilizador para outros tipos de dados. Para mais informações, consulte o tópico Conversão de Tipos Generalizada .

Notas para Implementadores

Se implementar a IConvertible interface, a sua implementação será chamada automaticamente pelo ChangeType(Object, Type) método se o Object parâmetro for uma instância do seu tipo de implementação e o Type parâmetro for um tipo de runtime de linguagem comum.

A maioria dos métodos de conversão tem um parâmetro de tipo IFormatProvider que representa a cultura atual (CurrentCulture) ou uma cultura específica. Na maior parte, as IConvertible implementações dos tipos base ignoram este parâmetro. No entanto, podes escolher se o queres usar no teu código.

Métodos

Name Description
GetTypeCode()

Devolve o TypeCode para este caso.

ToBoolean(IFormatProvider)

Converte o valor desta instância para um valor booleano equivalente usando a informação de formatação específica para cultura.

ToByte(IFormatProvider)

Converte o valor desta instância para um inteiro equivalente sem sinal de 8 bits usando a informação de formatação específica da cultura.

ToChar(IFormatProvider)

Converte o valor desta instância para um carácter Unicode equivalente usando a informação de formatação específica da cultura.

ToDateTime(IFormatProvider)

Converte o valor desta instância para um equivalente DateTime usando a informação de formatação específica da cultura.

ToDecimal(IFormatProvider)

Converte o valor desta instância para um número equivalente Decimal usando a informação de formatação específica de cultura especificada.

ToDouble(IFormatProvider)

Converte o valor desta instância para um número equivalente de ponto flutuante de dupla precisão usando a informação de formatação específica para cultura.

ToInt16(IFormatProvider)

Converte o valor desta instância para um inteiro assinado equivalente de 16 bits usando a informação de formatação específica da cultura.

ToInt32(IFormatProvider)

Converte o valor desta instância para um inteiro assinado equivalente de 32 bits usando a informação de formatação específica da cultura.

ToInt64(IFormatProvider)

Converte o valor desta instância para um inteiro assinado equivalente de 64 bits usando a informação de formatação específica da cultura.

ToSByte(IFormatProvider)

Converte o valor desta instância para um inteiro assinado equivalente de 8 bits usando a informação de formatação específica da cultura especificada.

ToSingle(IFormatProvider)

Converte o valor desta instância para um número equivalente de ponto flutuante de precisão simples usando a informação de formatação específica da cultura.

ToString(IFormatProvider)

Converte o valor desta instância para um equivalente String usando a informação de formatação específica da cultura.

ToType(Type, IFormatProvider)

Converte o valor desta instância para um Object de especificado Type que tem um valor equivalente, usando a informação de formatação específica da cultura.

ToUInt16(IFormatProvider)

Converte o valor desta instância para um inteiro não assinado equivalente de 16 bits usando a informação de formatação específica da cultura.

ToUInt32(IFormatProvider)

Converte o valor desta instância para um inteiro equivalente de 32 bits sem sinal usando a informação de formatação específica da cultura especificada.

ToUInt64(IFormatProvider)

Converte o valor desta instância para um inteiro equivalente sem sinal de 64 bits usando a informação de formatação específica da cultura.

Aplica-se a

Ver também