IConvertible 接口

定义

重要

此 API 不符合 CLS。

定义将实现引用或值类型的值转换为具有等效值的公共语言运行时类型的方法。

C#
[System.CLSCompliant(false)]
public interface IConvertible
C#
[System.CLSCompliant(false)]
[System.Runtime.InteropServices.ComVisible(true)]
public interface IConvertible
派生
属性

示例

下面的代码示例演示了复数类的IConvertible实现,允许先将其强制转换为静态Double成员,然后调用该Double类上的静态Convert成员。

C#
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;
            }
        }
    }
}

注解

此接口提供将实现类型的实例的值转换为具有等效值的公共语言运行时类型的方法。 公共语言运行时类型包括BooleanSByte、、ByteUInt16Int16DoubleSingleInt64UInt32Int32DecimalDateTimeUInt64Char和。String

如果公共语言运行时类型没有有意义的转换,则会引发 InvalidCastException特定的接口方法实现。 例如,如果此接口是在布尔类型上实现的,则该方法的 ToDateTime 实现将引发异常,因为布尔类型没有有意义的 DateTime 等效项。

公共语言运行时通常通过Convert类公开IConvertible接口。 公共语言运行时还使用 IConvertible 内部的接口,在显式接口实现中,以简化用于支持类中的 Convert 转换和基本公共语言运行时类型的转换的代码。

除了IConvertible接口,.NET Framework还提供称为类型转换器的类,用于将用户定义的数据类型转换为其他数据类型。 有关详细信息,请参阅 通用类型转换 主题。

实施者说明

如果实现IConvertible接口,则如果参数是实现类型的实例,并且参数是公共语言运行时类型,则Type该方法会自动调用ChangeType(Object, Type)Object实现。

大多数转换方法都有一个类型 IFormatProvider 参数,表示当前区域性 () CurrentCulture 或特定区域性。 在大多数情况下, IConvertible 基类型的实现将忽略此参数。 但是,可以选择是否在代码中使用它。

方法

GetTypeCode()

返回此实例的 TypeCode

ToBoolean(IFormatProvider)

使用指定的区域性特定格式设置信息将此实例的值转换为等效的 Boolean 值。

ToByte(IFormatProvider)

使用指定的区域性特定格式设置信息将该实例的值转换为等效的 8 位无符号整数。

ToChar(IFormatProvider)

使用指定的区域性特定格式设置信息将此实例的值转换为等效的 Unicode 字符。

ToDateTime(IFormatProvider)

使用指定的区域性特定格式设置信息将此实例的值转换为等效的 DateTime

ToDecimal(IFormatProvider)

使用指定的区域性特定格式设置信息将此实例的值转换为等效的 Decimal 数字。

ToDouble(IFormatProvider)

使用指定的区域性特定格式设置信息将此实例的值转换为等效的双精度浮点数字。

ToInt16(IFormatProvider)

使用指定的区域性特定格式设置信息将此实例的值转换为等效的 16 位有符号整数。

ToInt32(IFormatProvider)

使用指定的区域性特定格式设置信息将此实例的值转换为等效的 32 位有符号整数。

ToInt64(IFormatProvider)

使用指定的区域性特定格式设置信息将此实例的值转换为等效的 64 位有符号整数。

ToSByte(IFormatProvider)

使用指定的区域性特定格式设置信息将此实例的值转换为等效的 8 位有符号整数。

ToSingle(IFormatProvider)

使用指定的区域性特定格式设置信息将此实例的值转换为等效的单精度浮点数字。

ToString(IFormatProvider)

使用指定的区域性特定格式设置信息将此实例的值转换为等效的 String

ToType(Type, IFormatProvider)

使用指定的区域性特定格式设置信息将此实例的值转换为具有等效值的指定 ObjectType

ToUInt16(IFormatProvider)

使用指定的区域性特定格式设置信息将该实例的值转换为等效的 16 位无符号整数。

ToUInt32(IFormatProvider)

使用指定的区域性特定格式设置信息将该实例的值转换为等效的 32 位无符号整数。

ToUInt64(IFormatProvider)

使用指定的区域性特定格式设置信息将该实例的值转换为等效的 64 位无符号整数。

适用于

产品 版本
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8
.NET Standard 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0

另请参阅