DynamicObject Clase

Definición

Espacio de nombres:

System.Dynamic

Ensamblado:

System.Dynamic.Runtime.dll

Ensamblado:

System.Linq.Expressions.dll

Ensamblado:

System.Core.dll

Ensamblado:

netstandard.dll

Proporciona una clase base para especificar el comportamiento dinámico en tiempo de ejecución. Esta clase se debe heredar; no se puede crear una instancia de la clase directamente.

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

Herencia

Object

DynamicObject

Derivado

System.Windows.Interop.DynamicScriptObject

Atributos

SerializableAttribute

Implementaciones

IDynamicMetaObjectProvider

Ejemplos

Supongamos que desea proporcionar una sintaxis alternativa para acceder a los valores de un diccionario, de modo que, en lugar de escribir sampleDictionary["Text"] = "Sample text" (sampleDictionary("Text") = "Sample text" en Visual Basic), puede escribir sampleDictionary.Text = "Sample text". Además, quiere que esta sintaxis no distingue mayúsculas de minúsculas, por lo que es sampleDictionary.Text equivalente a sampleDictionary.text.

En el ejemplo de código siguiente se muestra la DynamicDictionary clase , que se deriva de la DynamicObject clase . La DynamicDictionary clase contiene un objeto del Dictionary<string, object> tipo (Dictionary(Of String, Object) en Visual Basic) para almacenar los pares clave-valor e invalida los TrySetMember métodos y TryGetMember para admitir la nueva sintaxis. También proporciona una Count propiedad , que muestra cuántas propiedades dinámicas contiene el diccionario.

// 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 obtener más ejemplos, vea Creating Wrappers with DynamicObject (Creación de contenedores con DynamicObject ) en el blog de Preguntas más frecuentes de C#.

Comentarios

La DynamicObject clase permite definir qué operaciones se pueden realizar en objetos dinámicos y cómo realizar esas operaciones. Por ejemplo, puede definir lo que sucede cuando intenta obtener o establecer una propiedad de objeto, llamar a un método o realizar operaciones matemáticas estándar, como suma y multiplicación.

Esta clase puede ser útil si desea crear un protocolo más cómodo para una biblioteca. Por ejemplo, si los usuarios de la biblioteca tienen que usar la sintaxis como Scriptobj.SetProperty("Count", 1), puede proporcionar la capacidad de usar una sintaxis mucho más sencilla, como scriptobj.Count = 1.

No se puede crear directamente una instancia de la DynamicObject clase . Para implementar el comportamiento dinámico, puede que desee heredar de la DynamicObject clase e invalidar los métodos necesarios. Por ejemplo, si solo necesita operaciones para establecer y obtener propiedades, puede invalidar solo los TrySetMember métodos y TryGetMember .

En C#, para habilitar el comportamiento dinámico para instancias de clases derivadas de la DynamicObject clase , debe usar la dynamic palabra clave . Para obtener más información, vea Uso del tipo dynamic.

En Visual Basic, las operaciones dinámicas son compatibles con el enlace en tiempo de entrega. Para obtener más información, vea Enlace anticipado y en tiempo de ejecución (Visual Basic) .

En el ejemplo de código siguiente se muestra cómo crear una instancia de una clase derivada de la DynamicObject clase .

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

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

También puede agregar sus propios miembros a las clases derivadas de la DynamicObject clase . Si la clase define las propiedades y también invalida el TrySetMember método , el entorno de ejecución de lenguaje dinámico (DLR) usa primero el enlazador de lenguaje para buscar una definición estática de una propiedad en la clase . Si no hay ninguna propiedad de este tipo, DLR llama al TrySetMember método .

La DynamicObject clase implementa la interfaz IDynamicMetaObjectProviderDLR , que permite compartir instancias de la DynamicObject clase entre lenguajes que admiten el modelo de interoperabilidad dlr. Por ejemplo, puede crear una instancia de la DynamicObject clase en C# y pasarla a una función IronPython. Para obtener más información, consulte Dynamic Language Runtime Overview.

Nota:

Si tiene un escenario sencillo en el que necesita un objeto que solo puede agregar y quitar miembros en tiempo de ejecución, pero que no necesita definir operaciones específicas y no tiene miembros estáticos, use la ExpandoObject clase .

Si tiene un escenario más avanzado en el que necesita definir cómo participan los objetos dinámicos en el protocolo de interoperabilidad, o bien necesita administrar el almacenamiento en caché dinámico de distribución dinámica de DLR, cree su propia implementación de la IDynamicMetaObjectProvider interfaz.

Constructores

DynamicObject()

Permite a los tipos derivados inicializar una nueva instancia del tipo DynamicObject.

Métodos

Equals(Object)	Determina si el objeto especificado es igual que el objeto actual. (Heredado de Object)
GetDynamicMemberNames()	Devuelve la enumeración de todos los nombres de miembro dinámicos.
GetHashCode()	Sirve como la función hash predeterminada. (Heredado de Object)
GetMetaObject(Expression)	Proporciona un objeto DynamicMetaObject que envía a los métodos virtuales dinámicos. El objeto se puede encapsular dentro de otro objeto DynamicMetaObject para proporcionar un comportamiento personalizado para acciones individuales. Este método admite la infraestructura de Dynamic Language Runtime para los implementadores de lenguaje y no está pensado para que se use directamente en el código.
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
MemberwiseClone()	Crea una copia superficial del Object actual. (Heredado de Object)
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)
TryBinaryOperation(BinaryOperationBinder, Object, Object)	Proporciona la implementación de operaciones binarias. Las clases derivadas de la clase DynamicObject pueden invalidar este método para especificar un comportamiento dinámico para operaciones como la suma o la multiplicación.
TryConvert(ConvertBinder, Object)	Proporciona la implementación de las operaciones de conversión de tipos. Las clases derivadas de la clase DynamicObject pueden invalidar este método para especificar el comportamiento dinámico de las operaciones que convierten un objeto de un tipo a otro.
TryCreateInstance(CreateInstanceBinder, Object[], Object)	Proporciona la implementación de las operaciones que inicializan una nueva instancia de un objeto dinámico. Este método no está pensado para su uso en C# o Visual Basic.
TryDeleteIndex(DeleteIndexBinder, Object[])	Proporciona la implementación de las operaciones que eliminan un objeto por índice. Este método no está pensado para su uso en C# o Visual Basic.
TryDeleteMember(DeleteMemberBinder)	Proporciona la implementación de las operaciones que eliminan un miembro de objeto. Este método no está pensado para su uso en C# o Visual Basic.
TryGetIndex(GetIndexBinder, Object[], Object)	Proporciona la implementación de las operaciones que obtienen un valor por índice. Las clases derivadas de la clase DynamicObject pueden invalidar este método para especificar un comportamiento dinámico para las operaciones de indización.
TryGetMember(GetMemberBinder, Object)	Proporciona la implementación de las operaciones que obtienen valores de miembro. Las clases derivadas de la clase DynamicObject pueden invalidar este método para especificar un comportamiento dinámico para operaciones como obtener el valor de una propiedad.
TryInvoke(InvokeBinder, Object[], Object)	Proporciona la implementación para las operaciones que invocan un objeto. Las clases derivadas de la clase DynamicObject pueden invalidar este método para especificar un comportamiento dinámico para operaciones como invocar un objeto o un delegado.
TryInvokeMember(InvokeMemberBinder, Object[], Object)	Proporciona la implementación de las operaciones que invocan un miembro. Las clases derivadas de la clase DynamicObject pueden invalidar este método para especificar un comportamiento dinámico para operaciones como llamar a un método.
TrySetIndex(SetIndexBinder, Object[], Object)	Proporciona la implementación de las operaciones que establecen un valor por índice. Las clases derivadas de la clase DynamicObject pueden invalidar este método para especificar el comportamiento dinámico de las operaciones que tienen acceso a los objetos por un índice especificado.
TrySetMember(SetMemberBinder, Object)	Proporciona la implementación de las operaciones que establecen valores de miembro. Las clases derivadas de la clase DynamicObject pueden invalidar este método para especificar un comportamiento dinámico para operaciones como establecer el valor de una propiedad.
TryUnaryOperation(UnaryOperationBinder, Object)	Proporciona la implementación de operaciones unarias. Las clases derivadas de la clase DynamicObject pueden invalidar este método para especificar el comportamiento dinámico de operaciones como negación, incremento o decremento.