IConvertible インターフェイス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
重要
この API は CLS 準拠ではありません。
実装する参照型または値型の値を、同等の値を持つ共通言語ランタイム型に変換するメソッドを定義します。
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
- 派生
- 属性
例
次のコード サンプルは、複素数クラスのIConvertibleの実装を示しています。これにより、最初にDoubleとしてキャストし、そのDoubleで静的なConvert メンバーを呼び出します。
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
注釈
このインターフェイスは、実装型のインスタンスの値を、同等の値を持つ共通言語ランタイム型に変換するメソッドを提供します。 共通言語ランタイムの種類は、 Boolean、 SByte、 Byte、 Int16、 UInt16、 Int32、 UInt32、 Int64、 UInt64、 Single、 Double、 Decimal、 DateTime、 Char、および Stringです。
共通言語ランタイム型への意味のある変換がない場合、特定のインターフェイス メソッドの実装は InvalidCastExceptionをスローします。 たとえば、このインターフェイスがブール型に実装されている場合、 ToDateTime メソッドの実装では、ブール型と同等の意味のある DateTime がないため、例外がスローされます。
共通言語ランタイムは、通常、Convert クラスを介してIConvertible インターフェイスを公開します。 共通言語ランタイムでは、明示的なインターフェイス実装で IConvertible インターフェイスを内部的に使用して、 Convert クラスの変換と基本的な共通言語ランタイム型の変換をサポートするために使用されるコードを簡略化します。
IConvertible インターフェイスに加えて、.NETでは、ユーザー定義データ型を他のデータ型に変換するための type コンバーター というクラスが提供されます。
注意 (実装者)
IConvertible インターフェイスを実装する場合、Object パラメーターが実装型のインスタンスであり、Type パラメーターが共通言語ランタイム型である場合、ChangeType(Object, Type) メソッドによって実装が自動的に呼び出されます。
ほとんどの変換メソッドには、現在のカルチャ (CurrentCulture) または特定のカルチャを表すIFormatProvider型のパラメーターがあります。 ほとんどの場合、基本型の IConvertible 実装では、このパラメーターは無視されます。 ただし、コードで使用するかどうかを選択できます。
メソッド
| 名前 | 説明 |
|---|---|
| GetTypeCode() |
このインスタンスの TypeCode を返します。 |
| ToBoolean(IFormatProvider) |
指定したカルチャ固有の書式情報を使用して、このインスタンスの値を等価のブール値に変換します。 |
| 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) |
指定したカルチャ固有の書式設定情報を使用して、このインスタンスの値を、同等の値を持つ指定したTypeのObjectに変換します。 |
| ToUInt16(IFormatProvider) |
指定したカルチャ固有の書式設定情報を使用して、このインスタンスの値を等価の 16 ビット符号なし整数に変換します。 |
| ToUInt32(IFormatProvider) |
指定したカルチャ固有の書式設定情報を使用して、このインスタンスの値を等価の 32 ビット符号なし整数に変換します。 |
| ToUInt64(IFormatProvider) |
指定したカルチャ固有の書式設定情報を使用して、このインスタンスの値を等価の 64 ビット符号なし整数に変換します。 |
適用対象
こちらもご覧ください
- .NET Framework での Type 変換