DynamicObject Classe

Definição

Namespace:

System.Dynamic

Assembly:

System.Linq.Expressions.dll

Origem:

DynamicObject.cs

Fornece uma classe base para especificar o comportamento dinâmico no tempo de execução. Essa classe deve ser herdada. Não é possível instanciá-la diretamente.

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

public class DynamicObject : System.Dynamic.IDynamicMetaObjectProvider

type DynamicObject = class
    interface IDynamicMetaObjectProvider

Public Class DynamicObject
Implements IDynamicMetaObjectProvider

Herança

Object

DynamicObject

Derivado

System.Windows.Interop.DynamicScriptObject

Implementações

IDynamicMetaObjectProvider

Exemplos

Suponha que você queira fornecer sintaxe alternativa para acessar valores em um dicionário, para que, em vez de escrever sampleDictionary["Text"] = "Sample text" (sampleDictionary("Text") = "Sample text" no Visual Basic), você possa escrever sampleDictionary.Text = "Sample text". Além disso, você deseja que essa sintaxe não diferencia maiúsculas de minúsculas, de modo que sampleDictionary.Text seja equivalente a sampleDictionary.text.

O exemplo de código a seguir demonstra a DynamicDictionary classe , que é derivada da DynamicObject classe . A DynamicDictionary classe contém um objeto do Dictionary<string, object> tipo (Dictionary(Of String, Object) no Visual Basic) para armazenar os pares chave-valor e substitui os TrySetMember métodos e TryGetMember para dar suporte à nova sintaxe. Ele 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 obter mais exemplos, consulte Criando Wrappers com DynamicObject no blog Perguntas Frequentes em C#.

Comentários

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

Essa classe pode ser útil se você quiser criar um protocolo mais conveniente para uma biblioteca. Por exemplo, se os usuários da biblioteca precisarem usar a sintaxe como Scriptobj.SetProperty("Count", 1), você poderá fornecer a capacidade de usar uma sintaxe muito mais simples, como scriptobj.Count = 1.

Você não pode criar diretamente uma instância da DynamicObject classe . Para implementar o comportamento dinâmico, talvez você queira herdar da classe e substituir os DynamicObject métodos necessários. Por exemplo, se você precisar apenas de operações para definir e obter propriedades, poderá substituir apenas os TrySetMember métodos e TryGetMember .

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

No Visual Basic, as operações dinâmicas têm suporte por associação tardia. Para obter mais informações, consulte Associação antecipada e tardia (Visual Basic).

O exemplo de código a seguir demonstra como criar uma instância de uma classe derivada da DynamicObject classe .

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

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

Você também pode adicionar seus próprios membros a classes derivadas da DynamicObject classe . Se sua classe definir propriedades e também substituir o TrySetMember método , o DLR (dynamic Language Runtime) primeiro usará o associador de idioma para procurar uma definição estática de uma propriedade na classe . Se não houver essa propriedade, a DLR chamará o TrySetMember método .

A DynamicObject classe implementa a interface IDynamicMetaObjectProviderDLR , que permite compartilhar instâncias da DynamicObject classe entre idiomas que dão suporte ao 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 obter mais informações, consulte Visão geral do Dynamic Language Runtime.

Observação

Se você tiver um cenário simples no qual precisa de um objeto que só possa adicionar e remover membros em tempo de execução, mas que não precise definir operações específicas e não tenha membros estáticos, use a ExpandoObject classe .

Se você tiver um cenário mais avançado no qual precisa definir como os objetos dinâmicos participam do protocolo de interoperabilidade ou se você precisa gerenciar o cache de expedição dinâmica rápida de DLR, crie sua própria implementação da IDynamicMetaObjectProvider interface.

Construtores

DynamicObject()

Habilita os tipos derivados para inicializarem uma nova instância do tipo DynamicObject.

Métodos

Equals(Object)	Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object)
GetDynamicMemberNames()	Retorna a enumeração de todos os nomes de membro dinâmico.
GetHashCode()	Serve como a função de hash padrão. (Herdado de Object)
GetMetaObject(Expression)	Fornece um DynamicMetaObject que expede para os métodos virtuais dinâmicos. O objeto pode ser encapsulado em outro DynamicMetaObject para fornecer um comportamento personalizado para ações individuais. Esse método dá suporte à infraestrutura do Dynamic Language Runtime para implementadores de linguagem e não se destina a ser usado diretamente do seu código.
GetType()	Obtém o Type da instância atual. (Herdado de Object)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)
TryBinaryOperation(BinaryOperationBinder, Object, Object)	Fornece implementação para operações binárias. As classes derivadas da classe DynamicObject podem substituir esse método a fim de especificar o comportamento dinâmico para operações como adição e multiplicação.
TryConvert(ConvertBinder, Object)	Fornece implementação para operações de conversão de tipo. As classes derivadas da classe DynamicObject podem substituir este método para especificar o comportamento dinâmico para operações que convertem um objeto de um tipo em outro.
TryCreateInstance(CreateInstanceBinder, Object[], Object)	Fornece a implementação para operações que inicializam uma nova instância de um objeto dinâmico. Esse método não se destina ao uso em C# ou Visual Basic.
TryDeleteIndex(DeleteIndexBinder, Object[])	Fornece a implementação para operações que excluem um objeto pelo índice. Esse método não se destina ao uso em C# ou Visual Basic.
TryDeleteMember(DeleteMemberBinder)	Fornece a implementação para operações que excluem um membro de objeto. Esse método não se destina ao uso em C# ou Visual Basic.
TryGetIndex(GetIndexBinder, Object[], Object)	Fornece a implementação para operações que obtêm um valor por índice. As classes derivadas da classe DynamicObject podem substituir esse método para especificar o comportamento dinâmico das operações de indexação.
TryGetMember(GetMemberBinder, Object)	Fornece a implementação para operações que obtêm valores de membro. As classes derivadas da classe DynamicObject podem substituir este método para especificar o comportamento dinâmico para operações como obtenção de um valor para uma propriedade.
TryInvoke(InvokeBinder, Object[], Object)	Fornece a implementação para operações que invocam um objeto. Classes derivadas da classe DynamicObject podem substituir este método para especificar o comportamento dinâmico para operações como invocar um objeto ou um delegado.
TryInvokeMember(InvokeMemberBinder, Object[], Object)	Fornece a implementação para operações que invocam um membro. As classes derivadas da classe DynamicObject podem substituir esse método a fim de especificar o comportamento dinâmico para operações como chamar um método.
TrySetIndex(SetIndexBinder, Object[], Object)	Fornece a implementação para operações que definem um valor por índice. As classes derivadas da classe DynamicObject podem substituir este método para especificar o comportamento dinâmico para operações que acessam os objetos por um índice especificado.
TrySetMember(SetMemberBinder, Object)	Fornece a implementação para operações que definem valores de membro. As classes derivadas da classe DynamicObject podem substituir este método para especificar o comportamento dinâmico para operações como definição de um valor para uma propriedade.
TryUnaryOperation(UnaryOperationBinder, Object)	Fornece implementação para operações unárias. As classes derivadas da classe DynamicObject podem substituir este método para especificar o comportamento dinâmico para operações como uma negação, incremento ou decremento.