PropertyInfo.SetValue Método

Definição

Namespace:

System.Reflection

Assembly:

System.Runtime.dll

Define o valor da propriedade de um objeto especificado.

Sobrecargas

SetValue(Object, Object)	Define o valor da propriedade de um objeto especificado.
SetValue(Object, Object, Object[])	Define o valor da propriedade de um objeto especificado com valores de índice opcionais para as propriedades de índice.
SetValue(Object, Object, BindingFlags, Binder, Object[], CultureInfo)	Quando é substituído em uma classe derivada, define o valor da propriedade de um objeto especificado que tem as informações específicas da cultura, índice e associação especificadas.

SetValue(Object, Object)

Origem:

PropertyInfo.cs

Define o valor da propriedade de um objeto especificado.

C#

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

Parâmetros

obj

Object

O objeto cujo valor da propriedade será definido.

value

Object

O novo valor da propriedade.

Exceções

ArgumentException

O acessador set da propriedade não foi encontrado.

- ou -

Não é possível converter value para o tipo de PropertyType.

TargetException

O tipo de obj não corresponde ao tipo de destino ou uma propriedade é uma propriedade de instância, mas obj é null.

Observação: no .NET para aplicativos da Windows Store ou na Biblioteca de Classes Portátil, capture Exception em vez disso.

MethodAccessException

Houve uma tentativa inválida de acessar um método privado ou protegido em uma classe.

Observação: no .NET para aplicativos da Windows Store ou na Biblioteca de Classes Portátil, capture a exceção de classe base, MemberAccessException, em vez disso.

TargetInvocationException

Ocorreu um erro ao definir o valor da propriedade. A propriedade InnerException indica o motivo do erro.

Exemplos

O exemplo a seguir declara uma classe chamada Example com uma static (Shared no Visual Basic) e uma propriedade de instância. O exemplo usa o SetValue(Object, Object) método para alterar os valores de propriedade originais e exibe os valores originais e finais.

C#

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

Comentários

A SetValue(Object, Object) sobrecarga define o valor de uma propriedade não indexada. Para determinar se uma propriedade é indexada, chame o GetIndexParameters método . Se a matriz resultante tiver 0 (zero), a propriedade não será indexada. Para definir o valor de uma propriedade indexada, chame a SetValue(Object, Object, Object[]) sobrecarga.

Se o tipo de propriedade desse PropertyInfo objeto for um tipo de valor e value for null, a propriedade será definida como o valor padrão para esse tipo.

Esse é um método de conveniência que chama a implementação de runtime do método abstrato SetValue(Object, Object, BindingFlags, Binder, Object[], CultureInfo) , especificando BindingFlags.Default para o BindingFlags parâmetro , null para Binder, null para Object[]e null para CultureInfo.

Para usar o SetValue método , primeiro obtenha um Type objeto que representa a classe . TypeNo , obtenha o PropertyInfo objeto . PropertyInfo No objeto , chame o SetValue método .

Nota

A partir do .NET Framework 2.0, esse método poderá ser usado para acessar membros não públicos se o chamador tiver sido concedido ReflectionPermission com o ReflectionPermissionFlag.RestrictedMemberAccess sinalizador e se o conjunto de concessões dos membros não públicos estiver restrito ao conjunto de concessões do chamador ou a um subconjunto dele. (Consulte Considerações de segurança para reflexão.) Para usar essa funcionalidade, seu aplicativo deve ter como destino o .NET Framework 3.5 ou posterior.

SetValue(Object, Object, Object[])

Origem:

PropertyInfo.cs

Define o valor da propriedade de um objeto especificado com valores de índice opcionais para as propriedades de índice.

C#

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

Parâmetros

obj

Object

O objeto cujo valor da propriedade será definido.

value

Object

O novo valor da propriedade.

index

Object[]

Valores de índice opcionais para propriedades indexadas. Esse valor deve ser null para propriedades não indexadas.

Exceções

ArgumentException

A matriz index não contém o tipo de argumentos necessários.

- ou -

O acessador set da propriedade não foi encontrado.

- ou -

Não é possível converter value para o tipo de PropertyType.

TargetException

O objeto não corresponde ao tipo de destino ou uma propriedade é uma propriedade de instância, mas obj é null.

Observação: no .NET para aplicativos da Windows Store ou na Biblioteca de Classes Portátil, capture Exception em vez disso.

TargetParameterCountException

O número de parâmetros em index não corresponde ao número de parâmetros usados pela propriedade indexada.

MethodAccessException

Houve uma tentativa inválida de acessar um método privado ou protegido em uma classe.

Observação: no .NET para aplicativos da Windows Store ou na Biblioteca de Classes Portátil, capture a exceção de classe base, MemberAccessException, em vez disso.

TargetInvocationException

Ocorreu um erro ao definir o valor da propriedade. Por exemplo, um valor de índice especificado para uma propriedade indexada está fora do intervalo. A propriedade InnerException indica o motivo do erro.

Exemplos

O exemplo a seguir define uma classe chamada TestClass que tem uma propriedade de leitura/gravação chamada Caption. Ele exibe o valor padrão da Caption propriedade, chama o SetValue método para alterar o valor da propriedade e exibe o resultado.

C#

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

Observe que, como a Caption propriedade não é uma matriz de parâmetros, o index argumento é null.

O exemplo a seguir declara uma classe chamada Example com três propriedades: uma static propriedade (Shared no Visual Basic), uma propriedade de instância e uma propriedade de instância indexada. O exemplo usa o SetValue método para alterar os valores padrão das propriedades e exibe os valores originais e finais.

O nome usado para pesquisar uma propriedade de instância indexada com reflexão é diferente dependendo do idioma e dos atributos aplicados à propriedade .

• No Visual Basic, o nome da propriedade é sempre usado para pesquisar a propriedade com reflexão. Você pode usar a Default palavra-chave para tornar a propriedade uma propriedade indexada padrão, nesse caso, você pode omitir o nome ao acessar a propriedade, como neste exemplo. Você também pode usar o nome da propriedade.

• Em C#, a propriedade de instância indexada é uma propriedade padrão chamada indexador e o nome nunca é usado ao acessar a propriedade no código. Por padrão, o nome da propriedade é Iteme você deve usar esse nome ao pesquisar a propriedade com reflexão. Você pode usar o IndexerNameAttribute atributo para dar ao indexador um nome diferente. Neste exemplo, o nome é IndexedInstanceProperty.

• No C++, o default especificador pode ser usado para tornar uma propriedade indexada uma propriedade indexada padrão (indexador de classe). Nesse caso, o nome da propriedade por padrão é Iteme você deve usar esse nome ao pesquisar a propriedade com reflexão, como neste exemplo. Você pode usar o IndexerNameAttribute atributo para dar ao indexador de classe um nome diferente na reflexão, mas não pode usar esse nome para acessar a propriedade no código. Uma propriedade indexada que não é um indexador de classe é acessada usando seu nome, tanto no código quanto na reflexão.

C#

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

Comentários

Se esse PropertyInfo objeto for um tipo de valor e value for null, a propriedade será definida como o valor padrão desse tipo.

Para determinar se uma propriedade é indexada, use o GetIndexParameters método . Se a matriz resultante tiver 0 (zero), a propriedade não será indexada.

Esse é um método de conveniência que chama a implementação de runtime do método abstrato SetValue(Object, Object, BindingFlags, Binder, Object[], CultureInfo) , especificando BindingFlags.Default para o BindingFlags parâmetro , null para Bindere null para CultureInfo.

Para usar o SetValue método , primeiro obtenha um Type objeto que representa a classe . TypeNo , obtenha o PropertyInfo. PropertyInfoNo , use o SetValue método .

Nota

A partir do .NET Framework 2.0, esse método poderá ser usado para acessar membros não públicos se o chamador tiver sido concedido ReflectionPermission com o ReflectionPermissionFlag.RestrictedMemberAccess sinalizador e se o conjunto de concessões dos membros não públicos estiver restrito ao conjunto de concessões do chamador ou a um subconjunto dele. (Consulte Considerações de segurança para reflexão.) Para usar essa funcionalidade, seu aplicativo deve ter como destino o .NET Framework 3.5 ou posterior.

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

Origem:

PropertyInfo.cs

Quando é substituído em uma classe derivada, define o valor da propriedade de um objeto especificado que tem as informações específicas da cultura, índice e associação especificadas.

C#

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

Parâmetros

obj

Object

O objeto cujo valor da propriedade será definido.

value

Object

O novo valor da propriedade.

invokeAttr

BindingFlags

Uma combinação bit a bit dos seguintes membros de enumeração que especifica o atributo de invocação: InvokeMethod, CreateInstance, Static, GetField, SetField, GetProperty ou SetProperty. É necessário especificar um atributo de invocação adequado. Por exemplo, para invocar um membro estático, defina o sinalizador Static.

binder

Binder

Um objeto que permite a associação, a coerção de tipos de argumento, a invocação de membros e a recuperação de objetos MemberInfo por meio da reflexão. Caso binder seja null, o associador padrão é usado.

index

Object[]

Valores de índice opcionais para propriedades indexadas. Esse valor deve ser null para propriedades não indexadas.

culture

CultureInfo

A cultura para a qual o recurso deve ser localizado. Se o recurso não estiver localizado para essa cultura, a propriedade Parent será chamada sucessivamente em busca de uma correspondência. Se esse valor for null, as informações específicas da cultura serão obtidas da propriedade CurrentUICulture.

Exceções

ArgumentException

A matriz index não contém o tipo de argumentos necessários.

- ou -

O acessador set da propriedade não foi encontrado.

- ou -

Não é possível converter value para o tipo de PropertyType.

TargetException

O objeto não corresponde ao tipo de destino ou uma propriedade é uma propriedade de instância, mas obj é null.

TargetParameterCountException

O número de parâmetros em index não corresponde ao número de parâmetros usados pela propriedade indexada.

MethodAccessException

Houve uma tentativa inválida de acessar um método privado ou protegido em uma classe.

TargetInvocationException

Ocorreu um erro ao definir o valor da propriedade. Por exemplo, um valor de índice especificado para uma propriedade indexada está fora do intervalo. A propriedade InnerException indica o motivo do erro.

Comentários

Se esse PropertyInfo objeto for um tipo de valor e value for null, a propriedade será definida como o valor padrão desse tipo.

Para determinar se uma propriedade é indexada, use o GetIndexParameters método . Se a matriz resultante tiver 0 (zero), a propriedade não será indexada.

As restrições de acesso são ignoradas para código totalmente confiável. Ou seja, construtores privados, métodos, campos e propriedades podem ser acessados e invocados por meio de Reflection sempre que o código for totalmente confiável.

Para usar o SetValue método , primeiro obtenha a classe Type. TypeNo , obtenha o PropertyInfo. PropertyInfoNo , use o SetValue método .

Nota

A partir do .NET Framework 2.0, esse método poderá ser usado para acessar membros não públicos se o chamador tiver sido concedido ReflectionPermission com o ReflectionPermissionFlag.RestrictedMemberAccess sinalizador e se o conjunto de concessões dos membros não públicos estiver restrito ao conjunto de concessões do chamador ou a um subconjunto dele. (Consulte Considerações de segurança para reflexão.) Para usar essa funcionalidade, seu aplicativo deve ter como destino o .NET Framework 3.5 ou posterior.