DynamicObject クラス

定義

名前空間:

System.Dynamic

アセンブリ:

netstandard.dll, System.Linq.Expressions.dll

ソース:

DynamicObject.cs

実行時に動的な動作を指定するための基本クラスを提供します。 このクラスは継承する必要があります。直接インスタンス化することはできません。

public ref class DynamicObject : System::Dynamic::IDynamicMetaObjectProvider

[System.Diagnostics.CodeAnalysis.RequiresDynamicCode("Creating a call site may require dynamic code generation.")]
public class DynamicObject : System.Dynamic.IDynamicMetaObjectProvider

[<System.Diagnostics.CodeAnalysis.RequiresDynamicCode("Creating a call site may require dynamic code generation.")>]
type DynamicObject = class
    interface IDynamicMetaObjectProvider

Public Class DynamicObject
Implements IDynamicMetaObjectProvider

継承

Object

DynamicObject

派生

System.Windows.Interop.DynamicScriptObject

属性

RequiresDynamicCodeAttribute

実装

IDynamicMetaObjectProvider

例

ディクショナリ内の値にアクセスするための代替構文を指定するとします。sampleDictionary["Text"] = "Sample text" (Visual Basic では sampleDictionary("Text") = "Sample text") を記述する代わりに、sampleDictionary.Text = "Sample text"を記述できます。 また、この構文では大文字と小文字が区別されないため、 sampleDictionary.Text は sampleDictionary.textと同じです。

次のコード例は、DynamicObject クラスから派生したDynamicDictionary クラスを示しています。 DynamicDictionary クラスには、キーと値のペアを格納する Dictionary<string, object> 型 (Visual Basic の Dictionary(Of String, Object)) のオブジェクトが含まれており、新しい構文をサポートするために TrySetMember メソッドと TryGetMember メソッドをオーバーライドします。 また、ディクショナリに含まれる動的プロパティの数を示す Count プロパティも提供します。

// The class derived from DynamicObject.
public class DynamicDictionary : DynamicObject
{
    // The inner dictionary.
    Dictionary<string, object> dictionary
        = new Dictionary<string, object>();

    // This property returns the number of elements
    // in the inner dictionary.
    public int Count
    {
        get
        {
            return dictionary.Count;
        }
    }

    // If you try to get a value of a property
    // not defined in the class, this method is called.
    public override bool TryGetMember(
        GetMemberBinder binder, out object result)
    {
        // Converting the property name to lowercase
        // so that property names become case-insensitive.
        string name = binder.Name.ToLower();

        // If the property name is found in a dictionary,
        // set the result parameter to the property value and return true.
        // Otherwise, return false.
        return dictionary.TryGetValue(name, out result);
    }

    // If you try to set a value of a property that is
    // not defined in the class, this method is called.
    public override bool TrySetMember(
        SetMemberBinder binder, object value)
    {
        // Converting the property name to lowercase
        // so that property names become case-insensitive.
        dictionary[binder.Name.ToLower()] = value;

        // You can always add a value to a dictionary,
        // so this method always returns true.
        return true;
    }
}

class Program
{
    static void Main(string[] args)
    {
        // Creating a dynamic dictionary.
        dynamic person = new DynamicDictionary();

        // Adding new dynamic properties.
        // The TrySetMember method is called.
        person.FirstName = "Ellen";
        person.LastName = "Adams";

        // Getting values of the dynamic properties.
        // The TryGetMember method is called.
        // Note that property names are case-insensitive.
        Console.WriteLine(person.firstname + " " + person.lastname);

        // Getting the value of the Count property.
        // The TryGetMember is not called,
        // because the property is defined in the class.
        Console.WriteLine(
            "Number of dynamic properties:" + person.Count);

        // The following statement throws an exception at run time.
        // There is no "address" property,
        // so the TryGetMember method returns false and this causes a
        // RuntimeBinderException.
        // Console.WriteLine(person.address);
    }
}

// This example has the following output:
// Ellen Adams
// Number of dynamic properties: 2

' The class derived from DynamicObject.
Public Class DynamicDictionary
    Inherits DynamicObject

    ' The inner dictionary.
    Dim dictionary As New Dictionary(Of String, Object)

    ' This property returns the number of elements
    ' in the inner dictionary.
    ReadOnly Property Count As Integer
        Get
            Return dictionary.Count
        End Get
    End Property


    ' If you try to get a value of a property that is
    ' not defined in the class, this method is called.

    Public Overrides Function TryGetMember(
        ByVal binder As System.Dynamic.GetMemberBinder,
        ByRef result As Object) As Boolean

        ' Converting the property name to lowercase
        ' so that property names become case-insensitive.
        Dim name As String = binder.Name.ToLower()

        ' If the property name is found in a dictionary,
        ' set the result parameter to the property value and return true.
        ' Otherwise, return false.
        Return dictionary.TryGetValue(name, result)
    End Function

    Public Overrides Function TrySetMember(
        ByVal binder As System.Dynamic.SetMemberBinder,
        ByVal value As Object) As Boolean

        ' Converting the property name to lowercase
        ' so that property names become case-insensitive.
        dictionary(binder.Name.ToLower()) = value

        ' You can always add a value to a dictionary,
        ' so this method always returns true.
        Return True
    End Function
End Class

Sub Main()
    ' Creating a dynamic dictionary.
    Dim person As Object = New DynamicDictionary()

    ' Adding new dynamic properties.
    ' The TrySetMember method is called.
    person.FirstName = "Ellen"
    person.LastName = "Adams"

    ' Getting values of the dynamic properties.
    ' The TryGetMember method is called.
    ' Note that property names are now case-insensitive,
    ' although they are case-sensitive in C#.
    Console.WriteLine(person.firstname & " " & person.lastname)

    ' Getting the value of the Count property.
    ' The TryGetMember is not called, 
    ' because the property is defined in the class.
    Console.WriteLine("Number of dynamic properties:" & person.Count)

    ' The following statement throws an exception at run time.
    ' There is no "address" property,
    ' so the TryGetMember method returns false and this causes
    ' a MissingMemberException.
    ' Console.WriteLine(person.address)
End Sub
' This examples has the following output:
' Ellen Adams
' Number of dynamic properties: 2

その他の例については、C# のよく寄せられる質問に関するブログの DynamicObject を使用したラッパーの作成 を参照してください。

注釈

DynamicObject クラスを使用すると、動的オブジェクトに対して実行できる操作とその操作の実行方法を定義できます。 たとえば、オブジェクト プロパティの取得または設定、メソッドの呼び出し、加算や乗算などの標準的な数学演算の実行を試みた場合の動作を定義できます。

このクラスは、ライブラリのより便利なプロトコルを作成する場合に便利です。 たとえば、ライブラリのユーザーが Scriptobj.SetProperty("Count", 1) などの構文を使用する必要がある場合は、 scriptobj.Count = 1のように、はるかに単純な構文を使用できます。

DynamicObject クラスのインスタンスを直接作成することはできません。 動的な動作を実装するには、 DynamicObject クラスから継承し、必要なメソッドをオーバーライドすることができます。 たとえば、プロパティの設定と取得に必要な操作のみが必要な場合は、 TrySetMember メソッドと TryGetMember メソッドのみをオーバーライドできます。

C# では、 DynamicObject クラスから派生したクラスのインスタンスに対して動的な動作を有効にするには、 dynamic キーワードを使用する必要があります。 詳細については、「 動的型の使用」を参照してください。

Visual Basic では、動的操作は遅延バインディングによってサポートされます。 詳細については、「 早期バインディングと遅延バインディング (Visual Basic)」を参照してください。

次のコード例では、 DynamicObject クラスから派生したクラスのインスタンスを作成する方法を示します。

public class SampleDynamicObject : DynamicObject {}
//...
dynamic sampleObject = new SampleDynamicObject ();

Public Class SampleDynamicObject
    Inherits DynamicObject
'...
Dim sampleObject As Object = New SampleDynamicObject()

DynamicObject クラスから派生したクラスに独自のメンバーを追加することもできます。 クラスでプロパティを定義し、 TrySetMember メソッドもオーバーライドする場合、動的言語ランタイム (DLR) は最初に言語バインダーを使用して、クラス内のプロパティの静的定義を検索します。 このようなプロパティがない場合、DLR は TrySetMember メソッドを呼び出します。

DynamicObject クラスは、DLR インターフェイス IDynamicMetaObjectProviderを実装します。これにより、DLR 相互運用性モデルをサポートする言語間でDynamicObject クラスのインスタンスを共有できます。 たとえば、C# で DynamicObject クラスのインスタンスを作成し、IronPython 関数に渡すことができます。 詳細については、「 動的言語ランタイムの概要」を参照してください。

注

実行時にのみメンバーを追加および削除できるが、特定の操作を定義する必要はなく、静的メンバーを持たないオブジェクトが必要な単純なシナリオがある場合は、 ExpandoObject クラスを使用します。

動的オブジェクトが相互運用性プロトコルにどのように参加するかを定義する必要があるより高度なシナリオがある場合、または DLR 高速動的ディスパッチ キャッシュを管理する必要がある場合は、 IDynamicMetaObjectProvider インターフェイスの独自の実装を作成します。

コンストラクター

名前	説明
DynamicObject()	派生型で、 DynamicObject 型の新しいインスタンスを初期化できるようにします。

メソッド

名前	説明
Equals(Object)	指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
GetDynamicMemberNames()	すべての動的メンバー名の列挙を返します。
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetMetaObject(Expression)	動的仮想メソッドにディスパッチする DynamicMetaObject を提供します。 オブジェクトを別の DynamicMetaObject 内にカプセル化して、個々のアクションにカスタム動作を提供できます。 このメソッドは、言語実装者向けの動的言語ランタイム インフラストラクチャをサポートしており、コードから直接使用するためのものではありません。
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
MemberwiseClone()	現在の Objectの簡易コピーを作成します。 (継承元 Object)
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)
TryBinaryOperation(BinaryOperationBinder, Object, Object)	バイナリ操作の実装を提供します。 DynamicObject クラスから派生したクラスは、このメソッドをオーバーライドして、加算や乗算などの操作の動的な動作を指定できます。
TryConvert(ConvertBinder, Object)	型変換操作の実装を提供します。 DynamicObject クラスから派生したクラスは、このメソッドをオーバーライドして、オブジェクトをある型から別の型に変換する操作の動的な動作を指定できます。
TryCreateInstance(CreateInstanceBinder, Object[], Object)	動的オブジェクトの新しいインスタンスを初期化する操作の実装を提供します。 このメソッドは、C# または Visual Basic での使用を意図していません。
TryDeleteIndex(DeleteIndexBinder, Object[])	インデックスによってオブジェクトを削除する操作の実装を提供します。 このメソッドは、C# または Visual Basic での使用を意図していません。
TryDeleteMember(DeleteMemberBinder)	オブジェクト メンバーを削除する操作の実装を提供します。 このメソッドは、C# または Visual Basic での使用を意図していません。
TryGetIndex(GetIndexBinder, Object[], Object)	インデックスによって値を取得する操作の実装を提供します。 DynamicObject クラスから派生したクラスは、このメソッドをオーバーライドして、インデックス作成操作の動的な動作を指定できます。
TryGetMember(GetMemberBinder, Object)	メンバー値を取得する操作の実装を提供します。 DynamicObject クラスから派生したクラスは、このメソッドをオーバーライドして、プロパティの値の取得などの操作の動的な動作を指定できます。
TryInvoke(InvokeBinder, Object[], Object)	オブジェクトを呼び出す操作の実装を提供します。 DynamicObject クラスから派生したクラスは、このメソッドをオーバーライドして、オブジェクトやデリゲートの呼び出しなどの操作の動的な動作を指定できます。
TryInvokeMember(InvokeMemberBinder, Object[], Object)	メンバーを呼び出す操作の実装を提供します。 DynamicObject クラスから派生したクラスは、このメソッドをオーバーライドして、メソッドの呼び出しなどの操作の動的な動作を指定できます。
TrySetIndex(SetIndexBinder, Object[], Object)	インデックスによって値を設定する操作の実装を提供します。 DynamicObject クラスから派生したクラスは、このメソッドをオーバーライドして、指定したインデックスによってオブジェクトにアクセスする操作の動的な動作を指定できます。
TrySetMember(SetMemberBinder, Object)	メンバー値を設定する操作の実装を提供します。 DynamicObject クラスから派生したクラスは、このメソッドをオーバーライドして、プロパティの値の設定などの操作の動的な動作を指定できます。
TryUnaryOperation(UnaryOperationBinder, Object)	単項演算の実装を提供します。 DynamicObject クラスから派生したクラスは、このメソッドをオーバーライドして、否定、インクリメント、デクリメントなどの操作の動的な動作を指定できます。