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" (sampleDictionary("Text") = "Sample text" в Visual Basic), можно написать sampleDictionary.Text = "Sample text". Кроме того, этот синтаксис должен быть нечувствительным к региструsampleDictionary.text, поэтому это sampleDictionary.Text эквивалентно.

В следующем примере кода демонстрируется класс, производный DynamicDictionary от DynamicObject класса. Класс DynamicDictionary содержит объект типа Dictionary<string, object> (Dictionary(Of String, Object) в Visual Basic) для хранения пар "ключ-значение" и переопределяет методы 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

Дополнительные примеры см. в разделе "Создание оболочки с помощью DynamicObject" в блоге по часто задаваемым вопросам на C#.

Комментарии

Класс DynamicObject позволяет определить, какие операции можно выполнять в динамических объектах и как выполнять эти операции. Например, можно определить, что происходит при попытке получить или задать свойство объекта, вызвать метод или выполнить стандартные математические операции, такие как добавление и умножение.

Этот класс может быть полезным, если вы хотите создать более удобный протокол для библиотеки. Например, если пользователям библиотеки придется использовать такой синтаксис Scriptobj.SetProperty("Count", 1), можно предоставить возможность использовать гораздо более простой синтаксис, например scriptobj.Count = 1.

Невозможно напрямую создать экземпляр DynamicObject класса. Для реализации динамического DynamicObject поведения может потребоваться наследовать от класса и переопределить необходимые методы. Например, если вам нужны только операции для задания и получения свойств, можно переопределить только TrySetMember методы и TryGetMember методы.

Чтобы включить динамическое поведение для экземпляров классов, производных от 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 реализует интерфейс IDynamicMetaObjectProviderDLR, который позволяет совместно использовать экземпляры DynamicObject класса между языками, поддерживающими модель взаимодействия DLR. Например, можно создать экземпляр DynamicObject класса в C# и передать его в функцию IronPython. Дополнительные сведения см. в разделе "Обзор динамической языковой среды выполнения".

Note

Если у вас есть простой сценарий, в котором требуется объект, который может добавлять и удалять только элементы во время выполнения, но это не требует определения конкретных операций и не имеет статических элементов, используйте 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 класса, могут переопределить этот метод, чтобы указать динамическое поведение для таких операций, как отрицание, увеличение или уменьшение.