DynamicObject DynamicObject DynamicObject DynamicObject Class

定義

実行時の動的な動作を指定するための基本クラスを提供します。Provides a base class for specifying dynamic behavior at run time. このクラスは継承する必要があり、直接インスタンス化することはできません。This class must be inherited from; you cannot instantiate it directly.

public ref class DynamicObject : System::Dynamic::IDynamicMetaObjectProvider
[System.Serializable]
public class DynamicObject : System.Dynamic.IDynamicMetaObjectProvider
type DynamicObject = class
    interface IDynamicMetaObjectProvider
Public Class DynamicObject
Implements IDynamicMetaObjectProvider
継承
DynamicObjectDynamicObjectDynamicObjectDynamicObject
派生
属性
実装

ディクショナリ内の値にアクセスするための別の構文を提供するとします。これsampleDictionary["Text"] = "Sample text"sampleDictionary("Text") = "Sample text"より、(Visual Basic で) をsampleDictionary.Text = "Sample text"記述するのではなく、を記述できます。Assume that you want to provide alternative syntax for accessing values in a dictionary, so that instead of writing sampleDictionary["Text"] = "Sample text" (sampleDictionary("Text") = "Sample text" in Visual Basic), you can write sampleDictionary.Text = "Sample text". また、この構文で大文字と小文字を区別しないsampleDictionary.TextようにするsampleDictionary.textため、はと同じになります。Also, you want this syntax to be case-insensitive, so that sampleDictionary.Text is equivalent to sampleDictionary.text.

DynamicDictionary クラスDynamicObjectから派生したクラスのコード例を次に示します。The following code example demonstrates the DynamicDictionary class, which is derived from the DynamicObject class. クラスDynamicDictionaryには、Dictionary(Of String, Object) Dictionary<string, object> キーと値のTryGetMemberペアを格納する型のオブジェクト (Visual Basic) が格納されています。また、メソッドとメソッドをオーバーライドして、新しい構文をサポートします。TrySetMemberThe DynamicDictionary class contains an object of the Dictionary<string, object> type (Dictionary(Of String, Object) in Visual Basic) to store the key-value pairs, and overrides the TrySetMember and TryGetMember methods to support the new syntax. また、 Countプロパティも用意されています。これは、ディクショナリに含まれる動的プロパティの数を示します。It also provides a Count property, which shows how many dynamic properties the dictionary contains.

// 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 を使用したラッパーの作成」を参照してください。For more examples, see Creating Wrappers with DynamicObject on the C# Frequently Asked Questions blog.

注釈

DynamicObjectクラスを使用すると、動的オブジェクトに対して実行できる操作とそれらの操作の実行方法を定義できます。The DynamicObject class enables you to define which operations can be performed on dynamic objects and how to perform those operations. たとえば、オブジェクトのプロパティを取得または設定したり、メソッドを呼び出したり、加算や乗算などの標準的な数値演算を実行しようとしたときに何が起こるかを定義できます。For example, you can define what happens when you try to get or set an object property, call a method, or perform standard mathematical operations such as addition and multiplication.

このクラスは、ライブラリに対してより便利なプロトコルを作成する場合に便利です。This class can be useful if you want to create a more convenient protocol for a library. たとえば、ライブラリのユーザーがのようなScriptobj.SetProperty("Count", 1)構文を使用する必要がある場合は、のように、より簡単なscriptobj.Count = 1構文を使用できるようにすることができます。For example, if users of your library have to use syntax like Scriptobj.SetProperty("Count", 1), you can provide the ability to use much simpler syntax, like scriptobj.Count = 1.

DynamicObjectクラスのインスタンスを直接作成することはできません。You cannot directly create an instance of the DynamicObject class. 動的な動作を実装するには、 DynamicObjectクラスを継承し、必要なメソッドをオーバーライドします。To implement the dynamic behavior, you may want to inherit from the DynamicObject class and override necessary methods. たとえば、プロパティを設定および取得するための操作のみが必要な場合は、メソッドTrySetMemberTryGetMemberメソッドだけをオーバーライドできます。For example, if you need only operations for setting and getting properties, you can override just the TrySetMember and TryGetMember methods.

でC#は、 DynamicObjectクラスから派生したクラスのインスタンスに対して動的な動作を有効dynamicにするには、キーワードを使用する必要があります。In C#, to enable dynamic behavior for instances of classes derived from the DynamicObject class, you must use the dynamic keyword. 詳細については、「dynamic 型の使用」を参照してください。For more information, see Using Type dynamic.

Visual Basic では、動的操作は遅延バインディングによってサポートされます。In Visual Basic, dynamic operations are supported by late binding. 詳細については、「事前バインディングと遅延バインディング」を参照してください。For more information, see Early and Late Binding.

DynamicObjectクラスから派生したクラスのインスタンスを作成する方法を次のコード例に示します。The following code example demonstrates how to create an instance of a class that is derived from the DynamicObject class.

public class SampleDynamicObject : DynamicObject {}  
//...  
dynamic sampleObject = new SampleDynamicObject ();  
Public Class SampleDynamicObject   
    Inherits DynamicObject  
'...  
Dim sampleObject As Object = New SampleDynamicObject()  

DynamicObjectクラスから派生したクラスに独自のメンバーを追加することもできます。You can also add your own members to classes derived from the DynamicObject class. クラスがプロパティを定義し、 TrySetMemberメソッドもオーバーライドする場合、動的言語ランタイム (DLR) はまず、言語バインダーを使用して、クラスのプロパティの静的定義を検索します。If your class defines properties and also overrides the TrySetMember method, the dynamic language runtime (DLR) first uses the language binder to look for a static definition of a property in the class. そのようなプロパティが存在しない場合、DLR TrySetMemberはメソッドを呼び出します。If there is no such property, the DLR calls the TrySetMember method.

クラスDynamicObjectは dlr インターフェイスIDynamicMetaObjectProviderを実装します。これにより、dlr 相互DynamicObject運用性モデルをサポートする言語間でクラスのインスタンスを共有できます。The DynamicObject class implements the DLR interface IDynamicMetaObjectProvider, which enables you to share instances of the DynamicObject class between languages that support the DLR interoperability model. たとえば、でDynamicObject C#クラスのインスタンスを作成し、それを IronPython 関数に渡すことができます。For example, you can create an instance of the DynamicObject class in C# and then pass it to an IronPython function. 詳細については、「動的言語ランタイムの概要」を参照してください。For more information, see Dynamic Language Runtime Overview.

注意

実行時にメンバーを追加および削除できるだけでなく、特定の操作を定義する必要がなく、静的メンバーを持たないオブジェクトが必要な単純なシナリオがある場合は、 ExpandoObjectクラスを使用します。If you have a simple scenario in which you need an object that can only add and remove members at run time but that does not need to define specific operations and does not have static members, use the ExpandoObject class.

相互運用性プロトコルに動的オブジェクトを含める方法を定義するより高度なシナリオがある場合、または DLR の高速動的ディスパッチキャッシュを管理する必要がある場合は、 IDynamicMetaObjectProviderインターフェイスの独自の実装を作成します。If you have a more advanced scenario in which you need to define how dynamic objects participate in the interoperability protocol, or you need to manage DLR fast dynamic dispatch caching, create your own implementation of the IDynamicMetaObjectProvider interface.

コンストラクター

DynamicObject() DynamicObject() DynamicObject() DynamicObject()

派生型で DynamicObject 型の新しいインスタンスを初期化できるようにします。Enables derived types to initialize a new instance of the DynamicObject type.

メソッド

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetDynamicMemberNames() GetDynamicMemberNames() GetDynamicMemberNames() GetDynamicMemberNames()

すべての動的メンバー名の列挙値を返します。Returns the enumeration of all dynamic member names.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(Inherited from Object)
GetMetaObject(Expression) GetMetaObject(Expression) GetMetaObject(Expression) GetMetaObject(Expression)

動的仮想メソッドにディスパッチされる DynamicMetaObject を提供します。Provides a DynamicMetaObject that dispatches to the dynamic virtual methods. このオブジェクトを別の DynamicMetaObject の内部にカプセル化することにより、個々のアクションのカスタム動作を指定することができます。The object can be encapsulated inside another DynamicMetaObject to provide custom behavior for individual actions. このメソッドは言語実装者向けの DLR (動的言語ランタイム) インフラストラクチャをサポートします。コードから直接使用するためのものではありません。This method supports the Dynamic Language Runtime infrastructure for language implementers and it is not intended to be used directly from your code.

GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(Inherited from Object)
TryBinaryOperation(BinaryOperationBinder, Object, Object) TryBinaryOperation(BinaryOperationBinder, Object, Object) TryBinaryOperation(BinaryOperationBinder, Object, Object) TryBinaryOperation(BinaryOperationBinder, Object, Object)

二項演算の実装を提供します。Provides implementation for binary operations. DynamicObject クラスの派生クラスでこのメソッドをオーバーライドして、加算や乗算などの演算の動的な動作を指定できます。Classes derived from the DynamicObject class can override this method to specify dynamic behavior for operations such as addition and multiplication.

TryConvert(ConvertBinder, Object) TryConvert(ConvertBinder, Object) TryConvert(ConvertBinder, Object) TryConvert(ConvertBinder, Object)

型変換演算の実装を提供します。Provides implementation for type conversion operations. DynamicObject クラスの派生クラスでこのメソッドをオーバーライドして、オブジェクトの型を別の型に変換する演算の動的な動作を指定できます。Classes derived from the DynamicObject class can override this method to specify dynamic behavior for operations that convert an object from one type to another.

TryCreateInstance(CreateInstanceBinder, Object[], Object) TryCreateInstance(CreateInstanceBinder, Object[], Object) TryCreateInstance(CreateInstanceBinder, Object[], Object) TryCreateInstance(CreateInstanceBinder, Object[], Object)

動的オブジェクトの新しいインスタンスを初期化する演算の実装を提供します。Provides the implementation for operations that initialize a new instance of a dynamic object. このメソッドは、C# または Visual Basic で使用するためのものではありません。This method is not intended for use in C# or Visual Basic.

TryDeleteIndex(DeleteIndexBinder, Object[]) TryDeleteIndex(DeleteIndexBinder, Object[]) TryDeleteIndex(DeleteIndexBinder, Object[]) TryDeleteIndex(DeleteIndexBinder, Object[])

インデックスを使用してオブジェクトを削除する演算の実装を提供します。Provides the implementation for operations that delete an object by index. このメソッドは、C# または Visual Basic で使用するためのものではありません。This method is not intended for use in C# or Visual Basic.

TryDeleteMember(DeleteMemberBinder) TryDeleteMember(DeleteMemberBinder) TryDeleteMember(DeleteMemberBinder) TryDeleteMember(DeleteMemberBinder)

オブジェクト メンバーを削除する演算の実装を提供します。Provides the implementation for operations that delete an object member. このメソッドは、C# または Visual Basic で使用するためのものではありません。This method is not intended for use in C# or Visual Basic.

TryGetIndex(GetIndexBinder, Object[], Object) TryGetIndex(GetIndexBinder, Object[], Object) TryGetIndex(GetIndexBinder, Object[], Object) TryGetIndex(GetIndexBinder, Object[], Object)

インデックスを使用して値を取得する演算の実装を提供します。Provides the implementation for operations that get a value by index. DynamicObject クラスの派生クラスでこのメソッドをオーバーライドして、インデックス演算の動的な動作を指定できます。Classes derived from the DynamicObject class can override this method to specify dynamic behavior for indexing operations.

TryGetMember(GetMemberBinder, Object) TryGetMember(GetMemberBinder, Object) TryGetMember(GetMemberBinder, Object) TryGetMember(GetMemberBinder, Object)

メンバー値を取得する演算の実装を提供します。Provides the implementation for operations that get member values. DynamicObject クラスの派生クラスでこのメソッドをオーバーライドして、プロパティ値の取得などの演算の動的な動作を指定できます。Classes derived from the DynamicObject class can override this method to specify dynamic behavior for operations such as getting a value for a property.

TryInvoke(InvokeBinder, Object[], Object) TryInvoke(InvokeBinder, Object[], Object) TryInvoke(InvokeBinder, Object[], Object) TryInvoke(InvokeBinder, Object[], Object)

オブジェクトを呼び出す演算の実装を提供します。Provides the implementation for operations that invoke an object. DynamicObject クラスの派生クラスでこのメソッドをオーバーライドして、オブジェクトやデリゲートの呼び出しなどの演算の動的な動作を指定できます。Classes derived from the DynamicObject class can override this method to specify dynamic behavior for operations such as invoking an object or a delegate.

TryInvokeMember(InvokeMemberBinder, Object[], Object) TryInvokeMember(InvokeMemberBinder, Object[], Object) TryInvokeMember(InvokeMemberBinder, Object[], Object) TryInvokeMember(InvokeMemberBinder, Object[], Object)

メンバーを呼び出す演算の実装を提供します。Provides the implementation for operations that invoke a member. DynamicObject クラスの派生クラスでこのメソッドをオーバーライドして、メソッドの呼び出しなどの演算の動的な動作を指定できます。Classes derived from the DynamicObject class can override this method to specify dynamic behavior for operations such as calling a method.

TrySetIndex(SetIndexBinder, Object[], Object) TrySetIndex(SetIndexBinder, Object[], Object) TrySetIndex(SetIndexBinder, Object[], Object) TrySetIndex(SetIndexBinder, Object[], Object)

インデックスを使用して値を設定する演算の実装を提供します。Provides the implementation for operations that set a value by index. DynamicObject クラスの派生クラスでこのメソッドをオーバーライドして、指定したインデックスを使用してオブジェクトにアクセスする演算の動的な動作を指定できます。Classes derived from the DynamicObject class can override this method to specify dynamic behavior for operations that access objects by a specified index.

TrySetMember(SetMemberBinder, Object) TrySetMember(SetMemberBinder, Object) TrySetMember(SetMemberBinder, Object) TrySetMember(SetMemberBinder, Object)

メンバー値を設定する演算の実装を提供します。Provides the implementation for operations that set member values. DynamicObject クラスの派生クラスでこのメソッドをオーバーライドして、プロパティ値の設定などの演算の動的な動作を指定できます。Classes derived from the DynamicObject class can override this method to specify dynamic behavior for operations such as setting a value for a property.

TryUnaryOperation(UnaryOperationBinder, Object) TryUnaryOperation(UnaryOperationBinder, Object) TryUnaryOperation(UnaryOperationBinder, Object) TryUnaryOperation(UnaryOperationBinder, Object)

単項演算の実装を提供します。Provides implementation for unary operations. DynamicObject クラスの派生クラスでこのメソッドをオーバーライドして、否定、インクリメント、デクリメントなどの演算の動的な動作を指定できます。Classes derived from the DynamicObject class can override this method to specify dynamic behavior for operations such as negation, increment, or decrement.

適用対象