Прочитать на английском

Поделиться через


PropertyInfo.SetValue Метод

Определение

Задает значение свойства для указанного объекта.

Перегрузки

SetValue(Object, Object)

Задает значение свойства указанного объекта.

SetValue(Object, Object, Object[])

Задает значение свойства указанного объекта с необязательными значениями индекса для свойств индекса.

SetValue(Object, Object, BindingFlags, Binder, Object[], CultureInfo)

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

SetValue(Object, Object)

Исходный код:
PropertyInfo.cs
Исходный код:
PropertyInfo.cs
Исходный код:
PropertyInfo.cs

Задает значение свойства указанного объекта.

public void SetValue (object obj, object value);
public void SetValue (object? obj, object? value);

Параметры

obj
Object

Объект, значение свойства которого будет задано.

value
Object

Новое значение свойства.

Исключения

Метод доступа set свойства не найден.

-или-

value нельзя преобразовать в тип PropertyType.

Тип obj не соответствует целевому типу или свойству является свойство экземпляра, но objnull.

Примечание. В .NET для приложений Магазина Windows или переносимой библиотеки классов, перехватите Exception.

Была неправлая попытка получить доступ к частному или защищенному методу внутри класса.

Примечание. В .NET для приложений Магазина Windows или переносимой библиотеки классов, перехватите исключение базового класса MemberAccessException.

Произошла ошибка при задании значения свойства. Свойство InnerException указывает причину ошибки.

Примеры

В следующем примере объявляется класс с именем Example с одним static (Shared в Visual Basic) и одним свойством экземпляра. В примере используется метод SetValue(Object, Object) для изменения исходных значений свойств и отображения исходных и конечных значений.

using System;
using System.Reflection;

class Example
{
    private static int _staticProperty = 41;
    private int _instanceProperty = 42;

    // Declare a public static property.
    public static int StaticProperty
    {
        get { return _staticProperty; }
        set { _staticProperty = value; }
    }

    // Declare a public instance property.
    public int InstanceProperty
    {
        get { return _instanceProperty; }
        set { _instanceProperty = value; }
    }

    public static void Main()
    {
        Console.WriteLine("Initial value of static property: {0}",
            Example.StaticProperty);

        // Get a type object that represents the Example type.
        Type examType = typeof(Example);

        // Change the static property value.
        PropertyInfo piShared = examType.GetProperty("StaticProperty");
        piShared.SetValue(null, 76);

        Console.WriteLine("New value of static property: {0}",
                          Example.StaticProperty);

        // Create an instance of the Example class.
        Example exam = new Example();

        Console.WriteLine("\nInitial value of instance property: {0}",
                          exam.InstanceProperty);

        // Change the instance property value.
        PropertyInfo piInstance = examType.GetProperty("InstanceProperty");
        piInstance.SetValue(exam, 37);

        Console.WriteLine("New value of instance property: {0}",
                          exam.InstanceProperty);
    }
}
// The example displays the following output:
//       Initial value of static property: 41
//       New value of static property: 76
//
//       Initial value of instance property: 42
//       New value of instance property: 37

Комментарии

Перегрузка SetValue(Object, Object) задает значение неиндексированного свойства. Чтобы определить, индексируется ли свойство, вызовите метод GetIndexParameters. Если результирующий массив содержит 0 (ноль) элементов, свойство не индексируется. Чтобы задать значение индексированного свойства, вызовите перегрузку SetValue(Object, Object, Object[]).

Если тип свойства этого объекта PropertyInfo является типом значения и valuenull, свойство будет задано значением по умолчанию для этого типа.

Это удобный метод, который вызывает реализацию абстрактного SetValue(Object, Object, BindingFlags, Binder, Object[], CultureInfo) метода, указывая BindingFlags.Default для параметра BindingFlags, null для Binder, null для Object[]и null для CultureInfo.

Чтобы использовать метод SetValue, сначала получите объект Type, представляющий класс. Из Typeполучите объект PropertyInfo. Из объекта PropertyInfo вызовите метод SetValue.

Примечание

Начиная с .NET Framework 2.0 этот метод можно использовать для доступа к недоступным членам, если вызывающий объект был предоставлен ReflectionPermission с флагом ReflectionPermissionFlag.RestrictedMemberAccess, и если набор предоставления недоступных членов ограничен набором предоставления вызывающего объекта или подмножеством. (См. вопросы безопасности для отражения.) Чтобы использовать эту функцию, приложение должно использовать .NET Framework 3.5 или более поздней версии.

Применяется к

.NET 9 и другие версии
Продукт Версии
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0

SetValue(Object, Object, Object[])

Исходный код:
PropertyInfo.cs
Исходный код:
PropertyInfo.cs
Исходный код:
PropertyInfo.cs

Задает значение свойства указанного объекта с необязательными значениями индекса для свойств индекса.

public virtual void SetValue (object obj, object value, object[] index);
public virtual void SetValue (object? obj, object? value, object?[]? index);

Параметры

obj
Object

Объект, значение свойства которого будет задано.

value
Object

Новое значение свойства.

index
Object[]

Необязательные значения индекса для индексированных свойств. Это значение должно быть null для неиндексированных свойств.

Реализации

Исключения

Массив index не содержит нужный тип аргументов.

-или-

Метод доступа set свойства не найден.

-или-

value нельзя преобразовать в тип PropertyType.

Объект не соответствует целевому типу, или свойство является свойством экземпляра, но objnull.

Примечание. В .NET для приложений Магазина Windows или переносимой библиотеки классов, перехватите Exception.

Число параметров в index не соответствует количеству параметров, которые принимает индексированные свойства.

Была неправлая попытка получить доступ к частному или защищенному методу внутри класса.

Примечание. В .NET для приложений Магазина Windows или переносимой библиотеки классов, перехватите исключение базового класса MemberAccessException.

Произошла ошибка при задании значения свойства. Например, значение индекса, указанное для индексированного свойства, выходит за пределы диапазона. Свойство InnerException указывает причину ошибки.

Примеры

В следующем примере определяется класс с именем TestClass с свойством чтения и записи с именем Caption. Он отображает значение по умолчанию свойства Caption, вызывает метод SetValue для изменения значения свойства и отображает результат.

using System;
using System.Reflection;

// Define a class with a property.
public class TestClass
{
    private string caption = "A Default caption";
    public string Caption
    {
        get { return caption; }
        set
        {
            if (caption != value)
            {
                caption = value;
            }
        }
    }
}

class TestPropertyInfo
{
    public static void Main()
    {
        TestClass t = new TestClass();

        // Get the type and PropertyInfo.
        Type myType = t.GetType();
        PropertyInfo pinfo = myType.GetProperty("Caption");

        // Display the property value, using the GetValue method.
        Console.WriteLine("\nGetValue: " + pinfo.GetValue(t, null));

        // Use the SetValue method to change the caption.
        pinfo.SetValue(t, "This caption has been changed.", null);

        //  Display the caption again.
        Console.WriteLine("GetValue: " + pinfo.GetValue(t, null));

        Console.WriteLine("\nPress the Enter key to continue.");
        Console.ReadLine();
    }
}

/*
This example produces the following output:

GetValue: A Default caption
GetValue: This caption has been changed

Press the Enter key to continue.
*/

Обратите внимание, что, поскольку свойство Caption не является массивом параметров, аргумент indexnull.

В следующем примере объявляется класс с именем Example с тремя свойствами: свойство static (Shared в Visual Basic), свойство экземпляра и свойство индексированного экземпляра. В примере используется метод SetValue для изменения значений свойств по умолчанию и отображения исходных и конечных значений.

Имя, используемое для поиска индексированного свойства экземпляра с отражением, отличается в зависимости от языка и атрибутов, примененных к свойству.

  • В Visual Basic имя свойства всегда используется для поиска свойства с отражением. Ключевое слово Default можно использовать для создания индексированного свойства по умолчанию, в этом случае можно опустить имя при доступе к свойству, как в этом примере. Также можно использовать имя свойства.

  • В C#свойство индексированного экземпляра является свойством по умолчанию, которое называется индексатором, и имя никогда не используется при доступе к свойству в коде. По умолчанию имя свойства Item, и при поиске свойства с отражением необходимо использовать это имя. Атрибут IndexerNameAttribute можно использовать для предоставления индексатору другого имени. В этом примере имя — IndexedInstanceProperty.

  • В C++описатель default можно использовать для создания индексированного свойства индексированного свойства по умолчанию (индексатора класса). В этом случае имя свойства по умолчанию Item, и при поиске свойства с отражением необходимо использовать это имя, как в этом примере. Атрибут IndexerNameAttribute можно использовать для предоставления индексатору класса другого имени в отражении, но это имя нельзя использовать для доступа к свойству в коде. Индексированного свойства, которое не является индексатором класса, осуществляется с помощью его имени, как в коде, так и в отражении.

using System;
using System.Reflection;
using System.Collections.Generic;
using System.Runtime.CompilerServices;

class Example
{
    private static int _staticProperty = 41;
    public static int StaticProperty
    {
        get
        {
            return _staticProperty;
        }
        set
        {
            _staticProperty = value;
        }
    }

    private int _instanceProperty = 42;
    public int InstanceProperty
    {
        get
        {
            return _instanceProperty;
        }
        set
        {
            _instanceProperty = value;
        }
    }

    private Dictionary<int, string> _indexedInstanceProperty =
        new Dictionary<int, string>();
    // By default, the indexer is named Item, and that name must be used
    // to search for the property. In this example, the indexer is given
    // a different name by using the IndexerNameAttribute attribute.
    [IndexerNameAttribute("IndexedInstanceProperty")]
    public string this[int key]
    {
        get
        {
            string returnValue = null;
            if (_indexedInstanceProperty.TryGetValue(key, out returnValue))
            {
                return returnValue;
            }
            else
            {
                return null;
            }
        }
        set
        {
            if (value == null)
            {
                throw new ArgumentNullException("IndexedInstanceProperty value can be an empty string, but it cannot be null.");
            }
            else
            {
                if (_indexedInstanceProperty.ContainsKey(key))
                {
                    _indexedInstanceProperty[key] = value;
                }
                else
                {
                    _indexedInstanceProperty.Add(key, value);
                }
            }
        }
    }

    public static void Main()
    {
        Console.WriteLine("Initial value of class-level property: {0}",
            Example.StaticProperty);

        PropertyInfo piShared = typeof(Example).GetProperty("StaticProperty");
        piShared.SetValue(null, 76, null);

        Console.WriteLine("Final value of class-level property: {0}",
            Example.StaticProperty);

        Example exam = new Example();

        Console.WriteLine("\nInitial value of instance property: {0}",
            exam.InstanceProperty);

        PropertyInfo piInstance =
            typeof(Example).GetProperty("InstanceProperty");
        piInstance.SetValue(exam, 37, null);

        Console.WriteLine("Final value of instance property: {0}",
            exam.InstanceProperty);

        exam[17] = "String number 17";
        exam[46] = "String number 46";
        exam[9] = "String number 9";

        Console.WriteLine(
            "\nInitial value of indexed instance property(17): '{0}'",
            exam[17]);

        // By default, the indexer is named Item, and that name must be used
        // to search for the property. In this example, the indexer is given
        // a different name by using the IndexerNameAttribute attribute.
        PropertyInfo piIndexedInstance =
            typeof(Example).GetProperty("IndexedInstanceProperty");
        piIndexedInstance.SetValue(
            exam,
            "New value for string number 17",
            new object[] { (int) 17 });

        Console.WriteLine(
            "Final value of indexed instance property(17): '{0}'",
            exam[17]);
    }
}

/* This example produces the following output:

Initial value of class-level property: 41
Final value of class-level property: 76

Initial value of instance property: 42
Final value of instance property: 37

Initial value of indexed instance property(17): 'String number 17'
Final value of indexed instance property(17): 'New value for string number 17'
 */

Комментарии

Если этот объект PropertyInfo является типом значения и valuenull, то свойство будет задано значением по умолчанию для этого типа.

Чтобы определить, индексируется ли свойство, используйте метод GetIndexParameters. Если результирующий массив содержит 0 (ноль) элементов, свойство не индексируется.

Это удобный метод, который вызывает реализацию абстрактного SetValue(Object, Object, BindingFlags, Binder, Object[], CultureInfo) метода, указывая BindingFlags.Default для параметра BindingFlags, null для Binderи null для CultureInfo.

Чтобы использовать метод SetValue, сначала получите объект Type, представляющий класс. Из Typeполучите PropertyInfo. В PropertyInfoиспользуйте метод SetValue.

Примечание

Начиная с .NET Framework 2.0 этот метод можно использовать для доступа к недоступным членам, если вызывающий объект был предоставлен ReflectionPermission с флагом ReflectionPermissionFlag.RestrictedMemberAccess, и если набор предоставления недоступных членов ограничен набором предоставления вызывающего объекта или подмножеством. (См. вопросы безопасности для отражения.) Чтобы использовать эту функцию, приложение должно использовать .NET Framework 3.5 или более поздней версии.

Применяется к

.NET 9 и другие версии
Продукт Версии
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0

SetValue(Object, Object, BindingFlags, Binder, Object[], CultureInfo)

Исходный код:
PropertyInfo.cs
Исходный код:
PropertyInfo.cs
Исходный код:
PropertyInfo.cs

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

public abstract void SetValue (object? obj, object? value, System.Reflection.BindingFlags invokeAttr, System.Reflection.Binder? binder, object?[]? index, System.Globalization.CultureInfo? culture);
public abstract void SetValue (object obj, object value, System.Reflection.BindingFlags invokeAttr, System.Reflection.Binder binder, object[] index, System.Globalization.CultureInfo culture);

Параметры

obj
Object

Объект, значение свойства которого будет задано.

value
Object

Новое значение свойства.

invokeAttr
BindingFlags

Побитовое сочетание следующих элементов перечисления, указывающих атрибут вызова: InvokeMethod, CreateInstance, Static, GetField, SetField, GetPropertyили SetProperty. Необходимо указать подходящий атрибут вызова. Например, чтобы вызвать статический элемент, задайте флаг Static.

binder
Binder

Объект, который включает привязку, приведение типов аргументов, вызов элементов и получение MemberInfo объектов через отражение. Если bindernull, используется привязка по умолчанию.

index
Object[]

Необязательные значения индекса для индексированных свойств. Это значение должно быть null для неиндексированных свойств.

culture
CultureInfo

Язык и региональные параметры, для которых должен быть локализован ресурс. Если ресурс не локализован для этого языка и региональных параметров, свойство Parent будет вызываться последовательно в поиске соответствия. Если это значение null, данные, относящиеся к языку и региональным параметрам, получаются из свойства CurrentUICulture.

Реализации

Исключения

Массив index не содержит нужный тип аргументов.

-или-

Метод доступа set свойства не найден.

-или-

value нельзя преобразовать в тип PropertyType.

Объект не соответствует целевому типу, или свойство является свойством экземпляра, но objnull.

Число параметров в index не соответствует количеству параметров, которые принимает индексированные свойства.

Была неправлая попытка получить доступ к частному или защищенному методу внутри класса.

Произошла ошибка при задании значения свойства. Например, значение индекса, указанное для индексированного свойства, выходит за пределы диапазона. Свойство InnerException указывает причину ошибки.

Комментарии

Если этот объект PropertyInfo является типом значения и valuenull, то свойство будет задано значением по умолчанию для этого типа.

Чтобы определить, индексируется ли свойство, используйте метод GetIndexParameters. Если результирующий массив содержит 0 (ноль) элементов, свойство не индексируется.

Ограничения доступа игнорируются для полностью доверенного кода. То есть к частным конструкторам, методам, полям и свойствам можно обращаться и вызывать с помощью отражения всякий раз, когда код полностью доверяется.

Чтобы использовать метод SetValue, сначала получите класс Type. Из Typeполучите PropertyInfo. В PropertyInfoиспользуйте метод SetValue.

Примечание

Начиная с .NET Framework 2.0 этот метод можно использовать для доступа к недоступным членам, если вызывающий объект был предоставлен ReflectionPermission с флагом ReflectionPermissionFlag.RestrictedMemberAccess, и если набор предоставления недоступных членов ограничен набором предоставления вызывающего объекта или подмножеством. (См. вопросы безопасности для отражения.) Чтобы использовать эту функцию, приложение должно использовать .NET Framework 3.5 или более поздней версии.

Применяется к

.NET 9 и другие версии
Продукт Версии
.NET Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1