Partilhar via


IConvertible Interface

Definição

Importante

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

Define métodos que convertem o valor do tipo de referência ou valor de implementação em um tipo de common language runtime que tem 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 a seguir demonstra uma implementação de IConvertible uma classe numérica Complexa, permitindo que ela seja lançada primeiro como um Double e, em seguida, chamando os membros estáticos Convert nisso 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

Comentários

Essa interface fornece métodos para converter o valor de uma instância de um tipo de implementação em um tipo de common language runtime que tenha um valor equivalente. Os tipos de common language runtime são Boolean, SByte, , Byte, Int16, UInt16, Int32, UInt32, Int64, , UInt64, , Single, Double, , Decimal, , DateTime, , Char, e String.

Se não houver nenhuma conversão significativa em um tipo de common language runtime, uma implementação de método de interface específica será gerada InvalidCastException. Por exemplo, se essa interface for implementada em um tipo booliano, a implementação do ToDateTime método gerará uma exceção porque não há nenhum equivalente significativo DateTime a um tipo booliano.

O common language runtime normalmente expõe a IConvertible interface por meio da Convert classe. O common language runtime também usa a IConvertible interface internamente, em implementações de interface explícitas, para simplificar o código usado para dar suporte a conversões nos Convert tipos de runtime de linguagem comum básicos e de classe.

Além da interface IConvertible, .NET fornece classes chamadas conversores type para converter tipos de dados definidos pelo usuário em outros tipos de dados.

Notas aos Implementadores

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

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 maioria das vezes, as IConvertible implementações dos tipos base ignoram esse parâmetro. No entanto, você pode escolher se deseja usá-lo em seu código.

Métodos

Nome Description
GetTypeCode()

Retorna o TypeCode para esta instância.

ToBoolean(IFormatProvider)

Converte o valor dessa instância em um valor booliano equivalente usando as informações de formatação específicas da cultura especificadas.

ToByte(IFormatProvider)

Converte o valor dessa instância em um inteiro sem sinal de 8 bits equivalente usando as informações de formatação específicas da cultura especificadas.

ToChar(IFormatProvider)

Converte o valor dessa instância em um caractere Unicode equivalente usando as informações de formatação específicas da cultura especificadas.

ToDateTime(IFormatProvider)

Converte o valor dessa instância em um equivalente DateTime usando as informações de formatação específicas da cultura especificadas.

ToDecimal(IFormatProvider)

Converte o valor dessa instância em um número equivalente Decimal usando as informações de formatação específicas da cultura especificadas.

ToDouble(IFormatProvider)

Converte o valor dessa instância em um número equivalente de ponto flutuante de precisão dupla usando as informações de formatação específicas da cultura especificadas.

ToInt16(IFormatProvider)

Converte o valor dessa instância em um inteiro com sinal equivalente de 16 bits usando as informações de formatação específicas da cultura especificadas.

ToInt32(IFormatProvider)

Converte o valor dessa instância em um inteiro com sinal equivalente de 32 bits usando as informações de formatação específicas da cultura especificadas.

ToInt64(IFormatProvider)

Converte o valor dessa instância em um inteiro com sinal equivalente de 64 bits usando as informações de formatação específicas da cultura especificadas.

ToSByte(IFormatProvider)

Converte o valor dessa instância em um inteiro com sinal equivalente de 8 bits usando as informações de formatação específicas da cultura especificadas.

ToSingle(IFormatProvider)

Converte o valor dessa instância em um número de ponto flutuante de precisão única equivalente usando as informações de formatação específicas da cultura especificadas.

ToString(IFormatProvider)

Converte o valor dessa instância em um equivalente String usando as informações de formatação específicas da cultura especificadas.

ToType(Type, IFormatProvider)

Converte o valor dessa instância em um Object dos especificados Type que tem um valor equivalente, usando as informações de formatação específicas da cultura especificadas.

ToUInt16(IFormatProvider)

Converte o valor dessa instância em um inteiro sem sinal de 16 bits equivalente usando as informações de formatação específicas da cultura especificadas.

ToUInt32(IFormatProvider)

Converte o valor dessa instância em um inteiro sem sinal de 32 bits equivalente usando as informações de formatação específicas da cultura especificadas.

ToUInt64(IFormatProvider)

Converte o valor dessa instância em um inteiro sem sinal de 64 bits equivalente usando as informações de formatação específicas da cultura especificadas.

Aplica-se a

Confira também