DynamicObject.TrySetIndex(SetIndexBinder, Object[], Object) Метод

Определение

Пространство имен:

System.Dynamic

Сборки:

netstandard.dll, System.Linq.Expressions.dll

Исходный код:

DynamicObject.cs

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

public:
 virtual bool TrySetIndex(System::Dynamic::SetIndexBinder ^ binder, cli::array <System::Object ^> ^ indexes, System::Object ^ value);

public virtual bool TrySetIndex(System.Dynamic.SetIndexBinder binder, object[] indexes, object? value);

abstract member TrySetIndex : System.Dynamic.SetIndexBinder * obj[] * obj -> bool
override this.TrySetIndex : System.Dynamic.SetIndexBinder * obj[] * obj -> bool

Public Overridable Function TrySetIndex (binder As SetIndexBinder, indexes As Object(), value As Object) As Boolean

Параметры

binder

SetIndexBinder

Предоставляет сведения об операции.

indexes

Object[]

Индексы, используемые в операции. Например, для операции sampleObject[3] = 10 в C# (sampleObject(3) = 10 в Visual Basic), где sampleObject является производным от класса DynamicObject, indexes[0] равно 3.

value

Object

Значение, заданное для объекта с указанным индексом. Например, для операции sampleObject[3] = 10 в C# (sampleObject(3) = 10 в Visual Basic), где sampleObject является производным от класса DynamicObject, value равно 10.

Возвращаемое значение

Boolean

Значение true, если операция выполнена успешно; в противном случае — значение false. Если этот метод возвращает false, привязка во время выполнения языка определяет поведение. (В большинстве случаев создается исключение времени выполнения для конкретного языка.

Примеры

Предположим, что необходимо создать объект, в котором можно получить доступ к свойствам, таким как Property0, Property1 и т. д., или по индексу, чтобы, например, sampleObject.Property0 эквивалентно sampleObject[0] в C# или sampleObject(0) в Visual Basic.

В следующем примере кода демонстрируется класс, производный SampleDynamicObject от DynamicObject класса. Класс SampleDynamicObject содержит объект типа Dictionary<string, object> (Dictionary(Of String, Object) в Visual Basic) для хранения пар "ключ-значение". SampleDynamicObject переопределяет TrySetIndex методы и TryGetIndex методы для включения доступа по индексу. Он переопределяет TrySetMember методы и TryGetMember методы для включения доступа по имени свойства.

// The class derived from DynamicObject.
public class SampleDynamicObject : DynamicObject
{
    // The inner dictionary to store field names and values.
    Dictionary<string, object> dictionary
        = new Dictionary<string, object>();

    // Get the property value.
    public override bool TryGetMember(
        GetMemberBinder binder, out object result)
    {
        return dictionary.TryGetValue(binder.Name, out result);
    }

    // Set the property value.
    public override bool TrySetMember(
        SetMemberBinder binder, object value)
    {
        dictionary[binder.Name] = value;
        return true;
    }

    // Set the property value by index.
    public override bool TrySetIndex(
        SetIndexBinder binder, object[] indexes, object value)
    {
        int index = (int)indexes[0];

        // If a corresponding property already exists, set the value.
        if (dictionary.ContainsKey("Property" + index))
            dictionary["Property" + index] = value;
        else
            // If a corresponding property does not exist, create it.
            dictionary.Add("Property" + index, value);
        return true;
    }

    // Get the property value by index.
    public override bool TryGetIndex(
        GetIndexBinder binder, object[] indexes, out object result)
    {

        int index = (int)indexes[0];
        return dictionary.TryGetValue("Property" + index, out result);
    }
}

class Program
{
    static void Test(string[] args)
    {
        // Creating a dynamic object.
        dynamic sampleObject = new SampleDynamicObject();

        // Creating Property0.
        // The TrySetMember method is called.
        sampleObject.Property0 = "Zero";

        // Getting the value by index.
        // The TryGetIndex method is called.
        Console.WriteLine(sampleObject[0]);

        // Setting the property value by index.
        // The TrySetIndex method is called.
        // (This method also creates Property1.)
        sampleObject[1] = 1;

        // Getting the Property1 value.
        // The TryGetMember method is called.
        Console.WriteLine(sampleObject.Property1);

        // The following statement produces a run-time exception
        // because there is no corresponding property.
        //Console.WriteLine(sampleObject[2]);
    }
}

// This code example produces the following output:

// Zero
// 1

' The class derived from DynamicObject.
Public Class SampleDynamicObject
    Inherits DynamicObject

    ' The inner dictionary to store field names and values.
    Dim dictionary As New Dictionary(Of String, Object)

    ' Get the property value.
    Public Overrides Function TryGetMember(
        ByVal binder As System.Dynamic.GetMemberBinder,
        ByRef result As Object) As Boolean

        Return dictionary.TryGetValue(binder.Name, result)

    End Function

    ' Set the property value.
    Public Overrides Function TrySetMember(
        ByVal binder As System.Dynamic.SetMemberBinder,
        ByVal value As Object) As Boolean

        dictionary(binder.Name) = value
        Return True

    End Function

    ' Set the property value by index.
    Public Overrides Function TrySetIndex(
        ByVal binder As System.Dynamic.SetIndexBinder,
        ByVal indexes() As Object, ByVal value As Object) As Boolean

        Dim index As Integer = CInt(indexes(0))
        ' If a corresponding property already exists, set the value.
        If (dictionary.ContainsKey("Property" & index)) Then
            dictionary("Property" & index) = value
        Else
            ' If a property does not exist, create it.
            dictionary.Add("Property" & index, value)
        End If
        Return True
    End Function

    ' Get the property value by index.
    Public Overrides Function TryGetIndex(
        ByVal binder As System.Dynamic.GetIndexBinder,
        ByVal indexes() As Object, ByRef result As Object) As Boolean

        Dim index = CInt(indexes(0))
        Return dictionary.TryGetValue("Property" & index, result)
    End Function
End Class

Sub Test()
    ' Creating a dynamic object.
    Dim sampleObject As Object = New SampleDynamicObject()

    ' Creating Property0.
    ' The TrySetMember method is called.
    sampleObject.Property0 = "Zero"

    ' Getting the value by index.
    ' The TryGetIndex method is called.
    Console.WriteLine(sampleObject(0))

    ' Setting the property value by index.
    ' The TrySetIndex method is called.
    ' (This method also creates Property1.)
    sampleObject(1) = 1

    ' Getting the Property1 value.
    ' The TryGetMember method is called.
    Console.WriteLine(sampleObject.Property1)

    ' The following statement produces a run-time exception
    ' because there is no corresponding property.
    ' Console.WriteLine(sampleObject(2))
End Sub

' This code example produces the following output:

' Zero
' 1

Комментарии

Классы, производные DynamicObject от класса, могут переопределить этот метод, чтобы указать, как операции, обращаюющиеся к объекту по индексу, должны выполняться для динамического объекта. Если метод не переопределен, привязка во время выполнения языка определяет поведение. (В большинстве случаев создается исключение времени выполнения для конкретного языка.)

Если этот метод переопределен, он автоматически вызывается при наличии операции, например sampleObject[3] = 10 в C# или sampleObject(3) = 10 в Visual Basic, где sampleObject является производным от класса DynamicObject.