PropertyInfo.SetValue Método

Definición

Espacio de nombres:

System.Reflection

Ensamblado:

System.Runtime.dll

Establece el valor de propiedad de un objeto especificado.

Sobrecargas

SetValue(Object, Object)	Establece el valor de propiedad de un objeto especificado.
SetValue(Object, Object, Object[])	Establece el valor de propiedad de un objeto especificado con valores de índice opcionales para las propiedades de índice.
SetValue(Object, Object, BindingFlags, Binder, Object[], CultureInfo)	Cuando se reemplaza en una clase derivada, establece el valor de propiedad de un objeto especificado que tiene la información específica del enlace, el índice y la referencia cultural especificados.

SetValue(Object, Object)

Source:

PropertyInfo.cs

Establece el valor de propiedad de un objeto especificado.

C#

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

Parámetros

obj

Object

Objeto cuyo valor de propiedad se establecerá.

value

Object

Nuevo valor de propiedad.

Excepciones

ArgumentException

No se encuentra el descriptor de acceso set de la propiedad.

-o-

value no se puede convertir al tipo de PropertyType.

TargetException

El tipo de obj no coincide con el tipo de destino o una propiedad es una propiedad de instancia, pero obj es null.

Nota: En .NET para aplicaciones de la Tienda Windows o la biblioteca de clases portable de , capture Exception en su lugar.

MethodAccessException

Hubo un intento ilegal de acceder a un método privado o protegido dentro de una clase .

Nota: En .NET para aplicaciones de la Tienda Windows o la biblioteca de clases portable de , captura la excepción de clase base, MemberAccessException, en su lugar.

TargetInvocationException

Error al establecer el valor de la propiedad. La propiedad InnerException indica el motivo del error.

Ejemplos

En el ejemplo siguiente se declara una clase denominada Example con una static (Shared en Visual Basic) y una propiedad de instancia. En el ejemplo se usa el método SetValue(Object, Object) para cambiar los valores de propiedad originales y se muestran los valores originales y finales.

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

Comentarios

La sobrecarga SetValue(Object, Object) establece el valor de una propiedad no indexada. Para determinar si una propiedad está indizada, llame al método GetIndexParameters. Si la matriz resultante tiene 0 elementos (cero), la propiedad no se indexa. Para establecer el valor de una propiedad indizada, llame a la sobrecarga SetValue(Object, Object, Object[]).

Si el tipo de propiedad de este objeto PropertyInfo es un tipo de valor y value es null, la propiedad se establecerá en el valor predeterminado de ese tipo.

Este es un método práctico que llama a la implementación en tiempo de ejecución del método de SetValue(Object, Object, BindingFlags, Binder, Object[], CultureInfo) abstracto, especificando BindingFlags.Default para el parámetro BindingFlags, null para Binder, null para Object[]y null para CultureInfo.

Para usar el método SetValue, obtenga primero un objeto Type que represente la clase . En el Type, obtenga el objeto PropertyInfo. Desde el objeto PropertyInfo, llame al método SetValue.

Nota

A partir de .NET Framework 2.0, este método se puede usar para acceder a miembros no públicos si se ha concedido al autor de la llamada ReflectionPermission con la marca ReflectionPermissionFlag.RestrictedMemberAccess y si el conjunto de concesión de los miembros no públicos está restringido al conjunto de concesión del autor de la llamada o a un subconjunto de ellos. (Consulte Consideraciones de seguridad para lade reflexión). Para usar esta funcionalidad, la aplicación debe tener como destino .NET Framework 3.5 o posterior.

SetValue(Object, Object, Object[])

Source:

PropertyInfo.cs

Establece el valor de propiedad de un objeto especificado con valores de índice opcionales para las propiedades de índice.

C#

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

Parámetros

obj

Object

Objeto cuyo valor de propiedad se establecerá.

value

Object

Nuevo valor de propiedad.

index

Object[]

Valores de índice opcionales para las propiedades indizada. Este valor debe ser null para las propiedades no indexadas.

Excepciones

ArgumentException

La matriz index no contiene el tipo de argumentos necesarios.

-o-

No se encuentra el descriptor de acceso set de la propiedad.

-o-

value no se puede convertir al tipo de PropertyType.

TargetException

El objeto no coincide con el tipo de destino o una propiedad es una propiedad de instancia, pero obj es null.

Nota: En .NET para aplicaciones de la Tienda Windows o la biblioteca de clases portable de , capture Exception en su lugar.

TargetParameterCountException

El número de parámetros de index no coincide con el número de parámetros que toma la propiedad indizada.

MethodAccessException

Hubo un intento ilegal de acceder a un método privado o protegido dentro de una clase .

Nota: En .NET para aplicaciones de la Tienda Windows o la biblioteca de clases portable de , captura la excepción de clase base, MemberAccessException, en su lugar.

TargetInvocationException

Error al establecer el valor de la propiedad. Por ejemplo, un valor de índice especificado para una propiedad indizada está fuera del intervalo. La propiedad InnerException indica el motivo del error.

Ejemplos

En el ejemplo siguiente se define una clase denominada TestClass que tiene una propiedad de lectura y escritura denominada Caption. Muestra el valor predeterminado de la propiedad Caption, llama al método SetValue para cambiar el valor de propiedad y muestra el 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.
*/

Tenga en cuenta que, dado que la propiedad Caption no es una matriz de parámetros, el argumento index es null.

En el ejemplo siguiente se declara una clase denominada Example con tres propiedades: una propiedad static (Shared en Visual Basic), una propiedad de instancia y una propiedad de instancia indizada. En el ejemplo se usa el método SetValue para cambiar los valores predeterminados de las propiedades y se muestran los valores originales y finales.

El nombre que se usa para buscar una propiedad de instancia indizada con reflexión es diferente en función del idioma y de los atributos aplicados a la propiedad.

• En Visual Basic, el nombre de propiedad siempre se usa para buscar la propiedad con reflexión. Puede usar la palabra clave Default para convertir la propiedad en una propiedad indexada predeterminada, en cuyo caso puede omitir el nombre al acceder a la propiedad, como en este ejemplo. También puede usar el nombre de la propiedad.

• En C#, la propiedad de instancia indizada es una propiedad predeterminada denominada indexador y el nombre nunca se usa al acceder a la propiedad en el código. De forma predeterminada, el nombre de la propiedad es Itemy debe usar ese nombre al buscar la propiedad con reflexión. Puede usar el atributo IndexerNameAttribute para asignar al indexador un nombre diferente. En este ejemplo, el nombre es IndexedInstanceProperty.

• En C++, el especificador de default se puede usar para convertir una propiedad indexada en una propiedad indexada predeterminada (indexador de clase). En ese caso, el nombre de la propiedad de forma predeterminada es Itemy debe usar ese nombre al buscar la propiedad con reflexión, como en este ejemplo. Puede usar el atributo IndexerNameAttribute para asignar al indexador de clase un nombre diferente en la reflexión, pero no puede usar ese nombre para tener acceso a la propiedad en el código. Se tiene acceso a una propiedad indizada que no es un indexador de clases mediante su nombre, tanto en código como en reflexión.

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

Comentarios

Si este objeto PropertyInfo es un tipo de valor y value es null, la propiedad se establecerá en el valor predeterminado de ese tipo.

Para determinar si una propiedad está indizada, use el método GetIndexParameters. Si la matriz resultante tiene 0 elementos (cero), la propiedad no se indexa.

Este es un método práctico que llama a la implementación en tiempo de ejecución del método de SetValue(Object, Object, BindingFlags, Binder, Object[], CultureInfo) abstracto, especificando BindingFlags.Default para el parámetro BindingFlags, null para Bindery null para CultureInfo.

Para usar el método SetValue, obtenga primero un objeto Type que represente la clase . En el Type, obtenga el PropertyInfo. En el PropertyInfo, use el método SetValue.

Nota

A partir de .NET Framework 2.0, este método se puede usar para acceder a miembros no públicos si se ha concedido al autor de la llamada ReflectionPermission con la marca ReflectionPermissionFlag.RestrictedMemberAccess y si el conjunto de concesión de los miembros no públicos está restringido al conjunto de concesión del autor de la llamada o a un subconjunto de ellos. (Consulte Consideraciones de seguridad para lade reflexión). Para usar esta funcionalidad, la aplicación debe tener como destino .NET Framework 3.5 o posterior.

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

Source:

PropertyInfo.cs

Cuando se reemplaza en una clase derivada, establece el valor de propiedad de un objeto especificado que tiene la información específica del enlace, el índice y la referencia cultural especificados.

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

Objeto cuyo valor de propiedad se establecerá.

value

Object

Nuevo valor de propiedad.

invokeAttr

BindingFlags

Combinación bit a bit de los siguientes miembros de enumeración que especifican el atributo de invocación: InvokeMethod, CreateInstance, Static, GetField, SetField, GetPropertyo SetProperty. Debe especificar un atributo de invocación adecuado. Por ejemplo, para invocar un miembro estático, establezca la marca Static.

binder

Binder

Objeto que permite el enlace, la coerción de tipos de argumentos, la invocación de miembros y la recuperación de objetos MemberInfo a través de la reflexión. Si binder es null, se usa el enlazador predeterminado.

index

Object[]

Valores de índice opcionales para las propiedades indizada. Este valor debe ser null para las propiedades no indexadas.

culture

CultureInfo

Referencia cultural para la que se va a localizar el recurso. Si el recurso no está localizado para esta referencia cultural, se llamará sucesivamente a la propiedad Parent en búsqueda de una coincidencia. Si este valor es null, la información específica de la referencia cultural se obtiene de la propiedad CurrentUICulture.

Excepciones

ArgumentException

La matriz index no contiene el tipo de argumentos necesarios.

-o-

No se encuentra el descriptor de acceso set de la propiedad.

-o-

value no se puede convertir al tipo de PropertyType.

TargetException

El objeto no coincide con el tipo de destino o una propiedad es una propiedad de instancia, pero obj es null.

TargetParameterCountException

El número de parámetros de index no coincide con el número de parámetros que toma la propiedad indizada.

MethodAccessException

Hubo un intento ilegal de acceder a un método privado o protegido dentro de una clase .

TargetInvocationException

Error al establecer el valor de la propiedad. Por ejemplo, un valor de índice especificado para una propiedad indizada está fuera del intervalo. La propiedad InnerException indica el motivo del error.

Comentarios

Si este objeto PropertyInfo es un tipo de valor y value es null, la propiedad se establecerá en el valor predeterminado de ese tipo.

Para determinar si una propiedad está indizada, use el método GetIndexParameters. Si la matriz resultante tiene 0 elementos (cero), la propiedad no se indexa.

Las restricciones de acceso se omiten para el código de plena confianza. Es decir, se puede acceder a constructores privados, métodos, campos y propiedades e invocarse a través de Reflection siempre que el código sea de plena confianza.

Para usar el método SetValue, obtenga primero la clase Type. En el Type, obtenga el PropertyInfo. En el PropertyInfo, use el método SetValue.

Nota

A partir de .NET Framework 2.0, este método se puede usar para acceder a miembros no públicos si se ha concedido al autor de la llamada ReflectionPermission con la marca ReflectionPermissionFlag.RestrictedMemberAccess y si el conjunto de concesión de los miembros no públicos está restringido al conjunto de concesión del autor de la llamada o a un subconjunto de ellos. (Consulte Consideraciones de seguridad para lade reflexión). Para usar esta funcionalidad, la aplicación debe tener como destino .NET Framework 3.5 o posterior.