PropertyInfo.SetValue Metod

Definition

Anger egenskapsvärdet för ett angivet objekt.

Överlagringar

Name Description
SetValue(Object, Object)

Anger egenskapsvärdet för ett angivet objekt.

SetValue(Object, Object, Object[])

Anger egenskapsvärdet för ett angivet objekt med valfria indexvärden för indexegenskaper.

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

När det åsidosätts i en härledd klass anger du egenskapsvärdet för ett angivet objekt som har angiven bindning, index och kulturspecifik information.

SetValue(Object, Object)

Anger egenskapsvärdet för ett angivet objekt.

public:
 void SetValue(System::Object ^ obj, System::Object ^ value);
public void SetValue(object obj, object value);
member this.SetValue : obj * obj -> unit
Public Sub SetValue (obj As Object, value As Object)

Parametrar

obj
Object

Objektet vars egenskapsvärde kommer att anges.

value
Object

Det nya egenskapsvärdet.

Undantag

Det gick inte att hitta egenskapens set accessor.

-eller-

value kan inte konverteras till typen PropertyType.

Typen av obj matchar inte måltypen, eller så är en egenskap en instansegenskap men obj är null.

Obs! I .NET för Windows Store-appar eller Portable Class Library fångar du Exception i stället.

Det gjordes ett olagligt försök att komma åt en privat eller skyddad metod i en klass.

Obs! I .NET för Windows Store-appar eller Portable Class Library fångar du i stället basklassfelet MemberAccessException.

Ett fel uppstod när egenskapsvärdet skulle anges. Egenskapen InnerException anger orsaken till felet.

Exempel

I följande exempel deklareras en klass med namnet Example med en static (Shared i Visual Basic) och en instansegenskap. I exemplet används SetValue(Object, Object) metoden för att ändra de ursprungliga egenskapsvärdena och visar de ursprungliga och slutliga värdena.

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
Imports System.Reflection

Class Example
    Private Shared _sharedProperty As Integer = 41
    Private _instanceProperty As Integer = 42

    ' Declare a public static (shared) property.
    Public Shared Property SharedProperty As Integer
        Get 
            Return _sharedProperty
        End Get
        Set
            _sharedProperty = Value
        End Set
    End Property

    ' Declare a public instance property.
    Public Property InstanceProperty As Integer
        Get 
            Return _instanceProperty
        End Get
        Set
            _instanceProperty = Value
        End Set
    End Property

    Public Shared Sub Main()
        Console.WriteLine("Initial value of shared property: {0}",
                          Example.SharedProperty)

        ' Get a type object that represents the Example type.
        Dim examType As Type = GetType(Example)
        
        ' Change the static (shared) property value.
        Dim piShared As PropertyInfo = examType.GetProperty("SharedProperty")
        piShared.SetValue(Nothing, 76)
                 
        Console.WriteLine("New value of shared property: {0}",
                          Example.SharedProperty)
        Console.WriteLine()

        ' Create an instance of the Example class.
        Dim exam As New Example

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

        ' Change the instance property value.
        Dim piInstance As PropertyInfo = examType.GetProperty("InstanceProperty")
        piInstance.SetValue(exam, 37)
                 
        Console.WriteLine("New value of instance property: {0}", _
                          exam.InstanceProperty)
    End Sub
End Class
' The example displays the following output:
'       Initial value of shared property: 41
'       New value of shared property: 76
'
'       Initial value of instance property: 42
'       New value of instance property: 37

Kommentarer

Överlagringen SetValue(Object, Object) anger värdet för en icke-indexerad egenskap. Om du vill avgöra om en egenskap är indexerad anropar du GetIndexParameters metoden. Om den resulterande matrisen har 0 (noll) element indexeras inte egenskapen. Om du vill ange värdet för en indexerad egenskap anropar du överlagringen SetValue(Object, Object, Object[]) .

Om egenskapstypen för det här PropertyInfo objektet är en värdetyp och value är null, anges egenskapen till standardvärdet för den typen.

Det här är en bekvämlighetsmetod som anropar körningsimplementeringen av den abstrakta SetValue(Object, Object, BindingFlags, Binder, Object[], CultureInfo) metoden och anger för parameternBindingFlags, null för Binder, null för Object[]och null för CultureInfo.BindingFlags.Default

Om du vill använda SetValue metoden hämtar du först ett Type objekt som representerar klassen. Hämta objektet från TypePropertyInfo . Anropa metoden från PropertyInfo objektet SetValue .

Note

Den här metoden kan användas för åtkomst till icke-offentliga medlemmar om anroparen har beviljats ReflectionPermission med ReflectionPermissionFlag.RestrictedMemberAccess flaggan och om bidragsuppsättningen för icke-offentliga medlemmar är begränsad till anroparens bidragsuppsättning eller en delmängd av den. (Se Säkerhetsöverväganden för reflektion.) Om du vill använda den här funktionen bör ditt program rikta in sig på .NET Framework 3.5 eller senare.

Gäller för

SetValue(Object, Object, Object[])

Anger egenskapsvärdet för ett angivet objekt med valfria indexvärden för indexegenskaper.

public:
 virtual void SetValue(System::Object ^ obj, System::Object ^ value, cli::array <System::Object ^> ^ index);
public virtual void SetValue(object obj, object value, object[] index);
abstract member SetValue : obj * obj * obj[] -> unit
override this.SetValue : obj * obj * obj[] -> unit
Public Overridable Sub SetValue (obj As Object, value As Object, index As Object())

Parametrar

obj
Object

Objektet vars egenskapsvärde kommer att anges.

value
Object

Det nya egenskapsvärdet.

index
Object[]

Valfria indexvärden för indexerade egenskaper. Det här värdet ska vara null för icke-indexerade egenskaper.

Implementeringar

Undantag

Matrisen index innehåller inte den typ av argument som behövs.

-eller-

Det gick inte att hitta egenskapens set accessor.

-eller-

value kan inte konverteras till typen PropertyType.

Objektet matchar inte måltypen, eller så är en egenskap en instansegenskap men obj är null.

Obs! I .NET för Windows Store-appar eller Portable Class Library fångar du Exception i stället.

Antalet parametrar i index matchar inte antalet parametrar som den indexerade egenskapen tar.

Det gjordes ett olagligt försök att komma åt en privat eller skyddad metod i en klass.

Obs! I .NET för Windows Store-appar eller Portable Class Library fångar du i stället basklassfelet MemberAccessException.

Ett fel uppstod när egenskapsvärdet skulle anges. Ett indexvärde som har angetts för en indexerad egenskap ligger till exempel inte inom intervallet. Egenskapen InnerException anger orsaken till felet.

Exempel

I följande exempel definieras en klass med namnet TestClass som har en skrivskyddad egenskap med namnet Caption. Den visar standardvärdet för Caption egenskapen, anropar SetValue metoden för att ändra egenskapsvärdet och visar resultatet.

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.
*/
Imports System.Reflection

' Define a class with a property.
Public Class TestClass
    Private myCaption As String = "A Default caption"

    Public Property Caption() As String
        Get
            Return myCaption
        End Get
        Set
            If myCaption <> value Then myCaption = value
        End Set
    End Property
End Class

Public Class TestPropertyInfo
    Public Shared Sub Main()
        Dim t As New TestClass()

        ' Get the type and PropertyInfo.
        Dim myType As Type = t.GetType()
        Dim pinfo As PropertyInfo = myType.GetProperty("Caption")

        ' Display the property value, using the GetValue method.
        Console.WriteLine(vbCrLf & "GetValue: " & pinfo.GetValue(t, Nothing))

        ' Use the SetValue method to change the caption.
        pinfo.SetValue(t, "This caption has been changed.", Nothing)

        ' Display the caption again.
        Console.WriteLine("GetValue: " & pinfo.GetValue(t, Nothing))

        Console.WriteLine(vbCrLf & "Press the Enter key to continue.")
        Console.ReadLine()
    End Sub
End Class

' This example produces the following output:
' 
'GetValue: A Default caption
'GetValue: This caption has been changed
'
'Press the Enter key to continue.

Observera att eftersom egenskapen Caption inte är en parametermatris index är nullargumentet .

I följande exempel deklareras en klass med namnet Example med tre egenskaper: en egenskap static (Shared i Visual Basic), en instansegenskap och en indexerad instansegenskap. I exemplet används SetValue metoden för att ändra standardvärdena för egenskaperna och visar de ursprungliga och slutliga värdena.

Namnet som används för att söka efter en indexerad instansegenskap med reflektion skiljer sig beroende på språk och attribut som tillämpas på egenskapen.

  • I Visual Basic används egenskapsnamnet alltid för att söka efter egenskapen med eftertanke. Du kan använda nyckelordet Default för att göra egenskapen till en standardindexerad egenskap, i vilket fall du kan utelämna namnet vid åtkomst till egenskapen, som i det här exemplet. Du kan också använda egenskapsnamnet.

  • I C# är den indexerade instansegenskapen en standardegenskap som kallas indexerare, och namnet används aldrig när du kommer åt egenskapen i kod. Som standard är Itemnamnet på egenskapen , och du måste använda det namnet när du söker efter egenskapen med reflektion. Du kan använda IndexerNameAttribute attributet för att ge indexeraren ett annat namn. I det här exemplet är IndexedInstanceProperty namnet.

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'
 */
Imports System.Reflection
Imports System.Collections.Generic

Class Example

    Private Shared _sharedProperty As Integer = 41
    Public Shared Property SharedProperty As Integer
        Get 
            Return _sharedProperty
        End Get
        Set
            _sharedProperty = Value
        End Set
    End Property

    Private _instanceProperty As Integer = 42
    Public Property InstanceProperty As Integer
        Get 
            Return _instanceProperty
        End Get
        Set
            _instanceProperty = Value
        End Set
    End Property

    Private _indexedInstanceProperty As New Dictionary(Of Integer, String)
    Default Public Property IndexedInstanceProperty(ByVal key As Integer) As String
        Get 
            Dim returnValue As String = Nothing
            If _indexedInstanceProperty.TryGetValue(key, returnValue) Then
                Return returnValue
            Else
                Return Nothing
            End If
        End Get
        Set
            If Value Is Nothing Then
                Throw New ArgumentNullException( _
                    "IndexedInstanceProperty value can be an empty string, but it cannot be Nothing.")
            Else
                If _indexedInstanceProperty.ContainsKey(key) Then
                    _indexedInstanceProperty(key) = Value
                Else
                    _indexedInstanceProperty.Add(key, Value)
                End If
            End If
        End Set
    End Property


    Shared Sub Main()

        Console.WriteLine("Initial value of class-level property: {0}", _
            Example.SharedProperty)

        Dim piShared As PropertyInfo = _
            GetType(Example).GetProperty("SharedProperty")
        piShared.SetValue( _
            Nothing, _
            76, _
            Nothing)
                 
        Console.WriteLine("Final value of class-level property: {0}", _
            Example.SharedProperty)


        Dim exam As New Example

        Console.WriteLine(vbCrLf & _
            "Initial value of instance property: {0}", _
            exam.InstanceProperty)

        Dim piInstance As PropertyInfo = _
            GetType(Example).GetProperty("InstanceProperty")
        piInstance.SetValue( _
            exam, _
            37, _
            Nothing)
                 
        Console.WriteLine("Final value of instance property: {0}", _
            exam.InstanceProperty)


        exam(17) = "String number 17"
        exam(46) = "String number 46"
        ' In Visual Basic, a default indexed property can also be referred
        ' to by name.
        exam.IndexedInstanceProperty(9) = "String number 9"

        Console.WriteLine(vbCrLf & _
            "Initial value of indexed instance property(17): '{0}'", _
            exam(17))

        Dim piIndexedInstance As PropertyInfo = _
            GetType(Example).GetProperty("IndexedInstanceProperty")
        piIndexedInstance.SetValue( _
            exam, _
            "New value for string number 17", _
            New Object() { CType(17, Integer) })
                 
        Console.WriteLine("Final value of indexed instance property(17): '{0}'", _
            exam(17))
        
    End Sub
End Class

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

Kommentarer

Om det här PropertyInfo objektet är en värdetyp och value är null, anges egenskapen till standardvärdet för den typen.

Använd metoden för GetIndexParameters att avgöra om en egenskap är indexerad. Om den resulterande matrisen har 0 (noll) element indexeras inte egenskapen.

Det här är en bekvämlighetsmetod som anropar körningsimplementeringen av den abstrakta SetValue(Object, Object, BindingFlags, Binder, Object[], CultureInfo) metoden, anger BindingFlags.Default för parametern BindingFlags , null för Binderoch null för CultureInfo.

Om du vill använda SetValue metoden hämtar du först ett Type objekt som representerar klassen. TypeFrån hämtar du PropertyInfo. PropertyInfoFrån använder du SetValue -metoden.

Note

I .NET Framework kan den här metoden användas för åtkomst till icke-offentliga medlemmar om anroparen har beviljats ReflectionPermission med flaggan ReflectionPermissionFlag.RestrictedMemberAccess och om bidragsuppsättningen för icke-offentliga medlemmar är begränsad till anroparens bidragsuppsättning eller en delmängd av den. (Se Säkerhetsöverväganden för reflektion.) Om du vill använda den här funktionen bör ditt program rikta in sig på .NET Framework 3.5 eller senare.

Gäller för

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

När det åsidosätts i en härledd klass anger du egenskapsvärdet för ett angivet objekt som har angiven bindning, index och kulturspecifik information.

public:
 abstract void SetValue(System::Object ^ obj, System::Object ^ value, System::Reflection::BindingFlags invokeAttr, System::Reflection::Binder ^ binder, cli::array <System::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);
abstract member SetValue : obj * obj * System.Reflection.BindingFlags * System.Reflection.Binder * obj[] * System.Globalization.CultureInfo -> unit
Public MustOverride Sub SetValue (obj As Object, value As Object, invokeAttr As BindingFlags, binder As Binder, index As Object(), culture As CultureInfo)

Parametrar

obj
Object

Objektet vars egenskapsvärde kommer att anges.

value
Object

Det nya egenskapsvärdet.

invokeAttr
BindingFlags

En bitvis kombination av följande uppräkningsmedlemmar som anger attributet anrop: InvokeMethod, , StaticCreateInstance, GetField, SetField, GetProperty, eller SetProperty. Du måste ange ett lämpligt anropsattribut. Om du till exempel vill anropa en statisk medlem anger du Static flaggan.

binder
Binder

Ett objekt som möjliggör bindning, tvång av argumenttyper, anrop av medlemmar och hämtning av MemberInfo objekt genom reflektion. Om binder är nullanvänds standardbindningen.

index
Object[]

Valfria indexvärden för indexerade egenskaper. Det här värdet ska vara null för icke-indexerade egenskaper.

culture
CultureInfo

Den kultur som resursen ska lokaliseras för. Om resursen inte är lokaliserad för den Parent här kulturen anropas egenskapen successivt på jakt efter en matchning. Om det här värdet är nullhämtas den kulturspecifika informationen från egenskapen CurrentUICulture .

Implementeringar

Undantag

Matrisen index innehåller inte den typ av argument som behövs.

-eller-

Det gick inte att hitta egenskapens set accessor.

-eller-

value kan inte konverteras till typen PropertyType.

Objektet matchar inte måltypen, eller så är en egenskap en instansegenskap men obj är null.

Antalet parametrar i index matchar inte antalet parametrar som den indexerade egenskapen tar.

Det gjordes ett olagligt försök att komma åt en privat eller skyddad metod i en klass.

Ett fel uppstod när egenskapsvärdet skulle anges. Ett indexvärde som har angetts för en indexerad egenskap ligger till exempel inte inom intervallet. Egenskapen InnerException anger orsaken till felet.

Kommentarer

Om det här PropertyInfo objektet är en värdetyp och value är null, anges egenskapen till standardvärdet för den typen.

Använd metoden för GetIndexParameters att avgöra om en egenskap är indexerad. Om den resulterande matrisen har 0 (noll) element indexeras inte egenskapen.

Åtkomstbegränsningar ignoreras för fullständigt betrodd kod. Det vill: privata konstruktorer, metoder, fält och egenskaper kan nås och anropas via Reflektion när koden är helt betrodd.

Om du vill använda SetValue metoden hämtar du först klassen Type. TypeFrån hämtar du PropertyInfo. PropertyInfoFrån använder du SetValue -metoden.

Note

Den här metoden kan användas för åtkomst till icke-offentliga medlemmar om anroparen har beviljats ReflectionPermission med ReflectionPermissionFlag.RestrictedMemberAccess flaggan och om bidragsuppsättningen för icke-offentliga medlemmar är begränsad till anroparens bidragsuppsättning eller en delmängd av den. (Se Säkerhetsöverväganden för reflektion.) Om du vill använda den här funktionen bör ditt program rikta in sig på .NET Framework 3.5 eller senare.

Gäller för