Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

IConvertible Interface

Defines methods that convert the value of the implementing reference or value type to a common language runtime type that has an equivalent value.

This API is not CLS-compliant. 

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)
[CLSCompliantAttribute(false)]
[ComVisibleAttribute(true)]
public interface IConvertible

The IConvertible type exposes the following members.

  NameDescription
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360GetTypeCodeReturns the TypeCode for this instance.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360ToBooleanConverts the value of this instance to an equivalent Boolean value using the specified culture-specific formatting information.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360ToByteConverts the value of this instance to an equivalent 8-bit unsigned integer using the specified culture-specific formatting information.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360ToCharConverts the value of this instance to an equivalent Unicode character using the specified culture-specific formatting information.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360ToDateTimeConverts the value of this instance to an equivalent DateTime using the specified culture-specific formatting information.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360ToDecimalConverts the value of this instance to an equivalent Decimal number using the specified culture-specific formatting information.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360ToDoubleConverts the value of this instance to an equivalent double-precision floating-point number using the specified culture-specific formatting information.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360ToInt16Converts the value of this instance to an equivalent 16-bit signed integer using the specified culture-specific formatting information.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360ToInt32Converts the value of this instance to an equivalent 32-bit signed integer using the specified culture-specific formatting information.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360ToInt64Converts the value of this instance to an equivalent 64-bit signed integer using the specified culture-specific formatting information.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360ToSByteConverts the value of this instance to an equivalent 8-bit signed integer using the specified culture-specific formatting information.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360ToSingleConverts the value of this instance to an equivalent single-precision floating-point number using the specified culture-specific formatting information.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360ToStringConverts the value of this instance to an equivalent String using the specified culture-specific formatting information.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360ToTypeConverts the value of this instance to an Object of the specified Type that has an equivalent value, using the specified culture-specific formatting information.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360ToUInt16Converts the value of this instance to an equivalent 16-bit unsigned integer using the specified culture-specific formatting information.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360ToUInt32Converts the value of this instance to an equivalent 32-bit unsigned integer using the specified culture-specific formatting information.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360ToUInt64Converts the value of this instance to an equivalent 64-bit unsigned integer using the specified culture-specific formatting information.
Top

This interface provides methods to convert the value of an instance of an implementing type to a common language runtime type that has an equivalent value. The common language runtime types are Boolean, SByte, Byte, Int16, UInt16, Int32, UInt32, Int64, UInt64, Single, Double, Decimal, DateTime, Char, and String.

If there is no meaningful conversion to a common language runtime type, then a particular interface method implementation throws InvalidCastException. For example, if this interface is implemented on a Boolean type, the implementation of the ToDateTime method throws an exception because there is no meaningful DateTime equivalent to a Boolean type.

The common language runtime typically exposes the IConvertible interface through the Convert class. The common language runtime also uses the IConvertible interface internally, in explicit interface implementations, to simplify the code used to support conversions in the Convert class and basic common language runtime types.

In addition to the IConvertible interface, the .NET Framework allows you to define a custom type converter to convert user-defined data types to other data types. A type converter is a class derived from System.ComponentModel.TypeConverter. It is associated with the class for which it serves as a type converter by applying the System.ComponentModel.TypeConverterAttribute attribute to that class.

Notes to Implementers

If you implement the IConvertible interface, your implementation will be called automatically by the ChangeType method if the Object parameter is an instance of your implementing type and the Type parameter is a common language runtime type.

Most IConvertible methods have a parameter of type IFormatProvider. This parameter commonly represents either the current culture (CultureInfo.CurrentCulture) or a specific culture. For the most part, the IConvertible implementations of the base types ignore this parameter. However, you can choose whether to use it in your code.

The following example demonstrates an implementation of IConvertible for a Complex number class, allowing it to be cast first as a Double and then calling the static Convert members on that Double.


using System;

/// 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 "( " + x.ToString() + " , " + y.ToString() + " )";
   }

   object IConvertible.ToType(Type conversionType, IFormatProvider provider)
   {
      return Convert.ChangeType(GetDoubleValue(), conversionType, provider);
   }

   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 Example
{
   public static void Demo(System.Windows.Controls.TextBlock outputBlock)
   {

      Complex testComplex = new Complex(4, 7);

      WriteObjectInfo(outputBlock, testComplex);
      WriteObjectInfo(outputBlock, Convert.ToBoolean(testComplex));
      WriteObjectInfo(outputBlock, Convert.ToDecimal(testComplex));
      WriteObjectInfo(outputBlock, Convert.ToString(testComplex));

   }

   static void WriteObjectInfo(System.Windows.Controls.TextBlock outputBlock, object testObject)
   {
      TypeCode typeCode = Type.GetTypeCode(testObject.GetType());

      switch (typeCode)
      {
         case TypeCode.Boolean:
            outputBlock.Text += String.Format("Boolean: {0}", testObject) + "\n";
            break;

         case TypeCode.Double:
            outputBlock.Text += String.Format("Double: {0}", testObject) + "\n";
            break;

         default:
            outputBlock.Text += String.Format("{0}: {1}", typeCode.ToString(), testObject) + "\n";
            break;
      }
   }
}


Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.