DynamicObject Classe

Definição

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

public class DynamicObject : System.Dynamic.IDynamicMetaObjectProvider

[System.Serializable]
public class DynamicObject : System.Dynamic.IDynamicMetaObjectProvider

type DynamicObject = class
    interface IDynamicMetaObjectProvider

[<System.Serializable>]
type DynamicObject = class
    interface IDynamicMetaObjectProvider

Public Class DynamicObject
Implements IDynamicMetaObjectProvider

Herança

Object

DynamicObject

Derivado

System.Windows.Interop.DynamicScriptObject

Atributos

SerializableAttribute

Implementações

IDynamicMetaObjectProvider

Exemplos

Suponha que quer fornecer uma sintaxe alternativa para aceder a valores num dicionário, de modo que, em vez de escrever sampleDictionary["Text"] = "Sample text" (sampleDictionary("Text") = "Sample text" em Visual Basic), possa escrever sampleDictionary.Text = "Sample text". Além disso, queres que esta sintaxe seja indistinta a maiúsculas e minúsculas, por isso sampleDictionary.Text é equivalente a sampleDictionary.text.

O exemplo de código seguinte demonstra a DynamicDictionary classe, que é derivada da DynamicObject classe. A classe DynamicDictionary contém um objeto do tipo Dictionary<string, object> (Dictionary(Of String, Object) em Visual Basic) para armazenar os pares-chave-valor, e sobrepõe os métodos TrySetMember e TryGetMember para suportar a nova sintaxe. Também fornece uma Count propriedade que mostra quantas propriedades dinâmicas o dicionário contém.

// 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

Para mais exemplos, consulte Criar Wrappers com DynamicObject no blogue Perguntas Frequentes em C#.

Observações

A DynamicObject classe permite-lhe definir quais as operações que podem ser realizadas em objetos dinâmicos e como realizar essas operações. Por exemplo, pode definir o que acontece quando tenta obter ou definir uma propriedade de objeto, chamar um método ou realizar operações matemáticas padrão como adição e multiplicação.

Esta classe pode ser útil se quiser criar um protocolo mais conveniente para uma biblioteca. Por exemplo, se os utilizadores da sua biblioteca tiverem de usar sintaxe como Scriptobj.SetProperty("Count", 1), pode fornecer a capacidade de usar sintaxe muito mais simples, como scriptobj.Count = 1.

Não podes criar diretamente uma instância da DynamicObject classe. Para implementar o comportamento dinâmico, pode querer herdar da DynamicObject classe e sobrepor métodos necessários. Por exemplo, se precisares apenas de operações para definir e obter propriedades, podes sobrepor apenas os TrySetMember métodos e.TryGetMember

Em C#, para permitir o comportamento dinâmico para instâncias de classes derivadas da DynamicObject classe, deve usar a dynamic palavra-chave. Para obter mais informações, consulte Usando o tipo dinâmico.

No Visual Basic, operações dinâmicas são suportadas por vinculação tardia. Para obter mais informações, consulte Vinculação antecipada e tardia (Visual Basic).

O exemplo de código seguinte demonstra como criar uma instância de uma classe derivada dessa DynamicObject classe.

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

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

Também pode adicionar os seus próprios membros a turmas derivadas da DynamicObject classe. Se a sua classe definir propriedades e também sobrescrever o TrySetMember método, o tempo de execução dinâmico da linguagem (DLR) usa primeiro o binder da linguagem para procurar uma definição estática de uma propriedade na classe. Se não existir tal propriedade, o DLR chama o TrySetMember método.

A DynamicObject classe implementa a interface IDynamicMetaObjectProviderDLR , que permite partilhar instâncias da DynamicObject classe entre linguagens que suportam o modelo de interoperabilidade DLR. Por exemplo, você pode criar uma instância da DynamicObject classe em C# e, em seguida, passá-la para uma função IronPython. Para mais informações, consulte Visão Geral de Execução da Linguagem Dinâmica.