DynamicObject.TrySetMember(SetMemberBinder, Object) Methode

Definition

Namespace:

System.Dynamic

Assembly:

System.Linq.Expressions.dll

Quelle:

DynamicObject.cs

Stellt die Implementierung für Vorgänge bereit, die Memberwerte festlegen. Von der DynamicObject-Klasse abgeleitete Klassen können diese Methode überschreiben, um dynamisches Verhalten für Vorgänge wie das Festlegen eines Werts für eine Eigenschaft anzugeben.

public:
 virtual bool TrySetMember(System::Dynamic::SetMemberBinder ^ binder, System::Object ^ value);

public virtual bool TrySetMember (System.Dynamic.SetMemberBinder binder, object? value);

abstract member TrySetMember : System.Dynamic.SetMemberBinder * obj -> bool
override this.TrySetMember : System.Dynamic.SetMemberBinder * obj -> bool

Public Overridable Function TrySetMember (binder As SetMemberBinder, value As Object) As Boolean

Parameter

binder

SetMemberBinder

Stellt Informationen zum Objekt bereit, das den dynamischen Vorgang aufgerufen hat. Die binder.Name -Eigenschaft gibt den Namen des Elements an, dem der Wert zugewiesen wird. Für die -Anweisung sampleObject.SampleProperty = "Test"gibt beispielsweise "SampleProperty" zurück, binder.Name wobei sampleObject ein instance der von der DynamicObject -Klasse abgeleiteten Klasse ist. Die binder.IgnoreCase -Eigenschaft gibt an, ob beim Membernamen die Groß-/Kleinschreibung beachtet wird.

value

Object

Der Wert, der auf den Member festgelegt werden soll. Für ist beispielsweise für sampleObject.SampleProperty = "Test", wobei sampleObject ein instance der von der DynamicObject -Klasse abgeleiteten Klasse ist, "valueTest".

Gibt zurück

Boolean

true, wenn der Vorgang erfolgreich ist, andernfalls false. Wenn die Methode false zurückgibt, wird das Verhalten vom Laufzeitbinder der Sprache bestimmt. (In den meisten Fällen wird eine sprachspezifische Laufzeitausnahme ausgelöst.)

Beispiele

Angenommen, Sie möchten alternative Syntax für den Zugriff auf Werte in einem Wörterbuch bereitstellen, sodass Sie nicht schreiben sampleDictionary["Text"] = "Sample text" (sampleDictionary("Text") = "Sample text" in Visual Basic) schreiben sampleDictionary.Text = "Sample text"können. Außerdem muss bei dieser Syntax die Groß-/Kleinschreibung nicht beachtet werden, sodass dies sampleDictionary.Text entspricht sampleDictionary.text.

Im folgenden Codebeispiel wird die DynamicDictionary -Klasse veranschaulicht, die von der DynamicObject -Klasse abgeleitet ist. Die DynamicDictionary -Klasse enthält ein Objekt des Dictionary<string, object> Typs (Dictionary(Of String, Object) in Visual Basic), um die Schlüssel-Wert-Paare zu speichern, und überschreibt die TrySetMember Methoden und TryGetMember , um die neue Syntax zu unterstützen. Außerdem wird eine Count Eigenschaft bereitgestellt, die angibt, wie viele dynamische Eigenschaften das Wörterbuch enthält.

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

Hinweise

Von der DynamicObject -Klasse abgeleitete Klassen können diese Methode überschreiben, um anzugeben, wie Vorgänge, die einen Wert auf einen Member festlegen, für ein dynamisches Objekt ausgeführt werden sollen. Wenn die Methode nicht überschrieben wird, bestimmt der Laufzeitbinder der Sprache das Verhalten. (In den meisten Fällen wird eine sprachspezifische Laufzeitausnahme ausgelöst.)

Diese Methode wird aufgerufen, wenn Sie Anweisungen wie sampleObject.SampleProperty = "Test"haben, wobei sampleObject ein instance der Klasse ist, die von der DynamicObject -Klasse abgeleitet ist.

Sie können auch eigene Member zu von der Klasse abgeleiteten DynamicObject Klassen hinzufügen. Wenn Ihre Klasse Eigenschaften definiert und die TrySetMember Methode auch außer Kraft setzt, verwendet die Dynamic Language Runtime (DLR) zunächst den Sprachbinder, um nach einer statischen Definition einer Eigenschaft in der -Klasse zu suchen. Wenn keine solche Eigenschaft vorhanden ist, ruft das DLR die -Methode auf TrySetMember .