PropertyInfo.SetValue メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
指定したオブジェクトのプロパティ値を設定します。
オーバーロード
| 名前 | 説明 |
|---|---|
| SetValue(Object, Object) |
指定したオブジェクトのプロパティ値を設定します。 |
| SetValue(Object, Object, Object[]) |
インデックス プロパティのオプションのインデックス値を使用して、指定したオブジェクトのプロパティ値を設定します。 |
| SetValue(Object, Object, BindingFlags, Binder, Object[], CultureInfo) |
派生クラスでオーバーライドされた場合、指定したバインディング、インデックス、カルチャ固有の情報を持つ指定したオブジェクトのプロパティ値を設定します。 |
SetValue(Object, Object)
- ソース:
- PropertyInfo.cs
- ソース:
- PropertyInfo.cs
- ソース:
- PropertyInfo.cs
- ソース:
- PropertyInfo.cs
- ソース:
- PropertyInfo.cs
指定したオブジェクトのプロパティ値を設定します。
public:
void SetValue(System::Object ^ obj, System::Object ^ value);
public void SetValue(object obj, object value);
public void SetValue(object? obj, object? value);
member this.SetValue : obj * obj -> unit
Public Sub SetValue (obj As Object, value As Object)
パラメーター
- obj
- Object
プロパティ値が設定されるオブジェクト。
- value
- Object
新しいプロパティ値。
例外
obj の型がターゲットの型と一致しないか、プロパティがインスタンス プロパティですが、obj が null。
クラス内のプライベート メソッドまたは保護されたメソッドに不正にアクセスしようとしました。
プロパティ値の設定中にエラーが発生しました。 InnerException プロパティは、エラーの理由を示します。
例
次の例では、Example という名前のクラスを、1 つの static (Visual Basic の Shared) と 1 つのインスタンス プロパティで宣言します。 この例では、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
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
注釈
SetValue(Object, Object) オーバーロードは、インデックスのないプロパティの値を設定します。 プロパティにインデックスが付いているかどうかを確認するには、GetIndexParameters メソッドを呼び出します。 結果の配列に 0 (ゼロ) の要素がある場合、プロパティのインデックスは作成されません。 インデックス付きプロパティの値を設定するには、SetValue(Object, Object, Object[]) オーバーロードを呼び出します。
この PropertyInfo オブジェクトのプロパティ型が値型であり、value が null場合、プロパティはその型の既定値に設定されます。
これは、抽象 SetValue(Object, Object, BindingFlags, Binder, Object[], CultureInfo) メソッドのランタイム実装を呼び出す便利なメソッドで、BindingFlags.Default パラメーターの BindingFlags、nullの Binder、nullの Object[]、および nullの CultureInfo を指定します。
SetValue メソッドを使用するには、まず、クラスを表す Type オブジェクトを取得します。 Typeから、PropertyInfo オブジェクトを取得します。 PropertyInfo オブジェクトから、SetValue メソッドを呼び出します。
手記
このメソッドを使用すると、呼び出し元が ReflectionPermission フラグを持つReflectionPermissionFlag.RestrictedMemberAccessを許可されている場合、および非パブリック メンバーの許可セットが呼び出し元の許可セットまたはそのサブセットに制限されている場合に、非パブリック メンバーにアクセスできます。 (「リフレクションのセキュリティに関する考慮事項」を参照してください>)。この機能を使用するには、アプリケーションで Framework 3.5 以降.NETターゲットにする必要があります。
適用対象
SetValue(Object, Object, Object[])
- ソース:
- PropertyInfo.cs
- ソース:
- PropertyInfo.cs
- ソース:
- PropertyInfo.cs
- ソース:
- PropertyInfo.cs
- ソース:
- PropertyInfo.cs
インデックス プロパティのオプションのインデックス値を使用して、指定したオブジェクトのプロパティ値を設定します。
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);
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())
パラメーター
- obj
- Object
プロパティ値が設定されるオブジェクト。
- value
- Object
新しいプロパティ値。
- index
- Object[]
インデックス付きプロパティのオプションのインデックス値。 この値は、インデックスのないプロパティに対して null する必要があります。
実装
例外
index 配列には、必要な引数の型が含まれていません。
-又は-
プロパティの set アクセサーが見つかりません。
-又は-
value を PropertyTypeの型に変換することはできません。
オブジェクトがターゲットの型と一致しないか、プロパティがインスタンス プロパティですが、obj が null。
index 内のパラメーターの数が、インデックス付きプロパティが受け取るパラメーターの数と一致しません。
クラス内のプライベート メソッドまたは保護されたメソッドに不正にアクセスしようとしました。
プロパティ値の設定中にエラーが発生しました。 たとえば、インデックス付きプロパティに指定されたインデックス値が範囲外です。 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.
*/
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.
Caption プロパティはパラメーター配列ではないため、index 引数は nullされることに注意してください。
次の例では、Example という名前のクラスを 3 つのプロパティで宣言します。static プロパティ (Visual Basic では Shared)、インスタンス プロパティ、インデックス付きインスタンス プロパティです。 この例では、SetValue メソッドを使用してプロパティの既定値を変更し、元の値と最終的な値を表示します。
リフレクションを使用してインデックス付きインスタンス プロパティを検索するために使用される名前は、言語とプロパティに適用される属性によって異なります。
Visual Basicでは、プロパティ名は常にリフレクションを使用してプロパティを検索するために使用されます。
Defaultキーワードを使用すると、プロパティを既定のインデックス付きプロパティにすることができます。この場合、この例のように、プロパティにアクセスするときに名前を省略できます。 プロパティ名を使用することもできます。C# では、インデックス付きインスタンス プロパティはインデクサーと呼ばれる既定のプロパティであり、コード内のプロパティにアクセスするときに名前は使用されません。 既定では、プロパティの名前は
Itemです。リフレクションを使用してプロパティを検索するときは、その名前を使用する必要があります。 IndexerNameAttribute 属性を使用して、インデクサーに別の名前を付けることができます。 この例では、名前はIndexedInstancePropertyです。
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'
注釈
この PropertyInfo オブジェクトが値型で、value が null場合、プロパティはその型の既定値に設定されます。
プロパティにインデックスが付いているかどうかを確認するには、GetIndexParameters メソッドを使用します。 結果の配列に 0 (ゼロ) の要素がある場合、プロパティのインデックスは作成されません。
これは、抽象 SetValue(Object, Object, BindingFlags, Binder, Object[], CultureInfo) メソッドのランタイム実装を呼び出し、BindingFlags.Default パラメーターの BindingFlags、nullの Binder、および nullの CultureInfo を指定する便利なメソッドです。
SetValue メソッドを使用するには、まず、クラスを表す Type オブジェクトを取得します。 Typeから、PropertyInfoを取得します。 PropertyInfoから、SetValue メソッドを使用します。
手記
.NET Framework では、呼び出し元が ReflectionPermissionFlag.RestrictedMemberAccess フラグを使用して ReflectionPermission を付与されている場合、および非パブリック メンバーの許可セットが呼び出し元の許可セットまたはそのサブセットに制限されている場合は、このメソッドを使用して非パブリック メンバーにアクセスできます。 (「リフレクションのセキュリティに関する考慮事項」を参照してください>)。この機能を使用するには、アプリケーションで Framework 3.5 以降.NETターゲットにする必要があります。
適用対象
SetValue(Object, Object, BindingFlags, Binder, Object[], CultureInfo)
- ソース:
- PropertyInfo.cs
- ソース:
- PropertyInfo.cs
- ソース:
- PropertyInfo.cs
- ソース:
- PropertyInfo.cs
- ソース:
- PropertyInfo.cs
派生クラスでオーバーライドされた場合、指定したバインディング、インデックス、カルチャ固有の情報を持つ指定したオブジェクトのプロパティ値を設定します。
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);
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)
パラメーター
- obj
- Object
プロパティ値が設定されるオブジェクト。
- value
- Object
新しいプロパティ値。
- invokeAttr
- BindingFlags
呼び出し属性を指定する次の列挙メンバーのビットごとの組み合わせ: InvokeMethod、CreateInstance、Static、GetField、SetField、GetProperty、または SetProperty。 適切な呼び出し属性を指定する必要があります。 たとえば、静的メンバーを呼び出すには、Static フラグを設定します。
- binder
- Binder
バインディング、引数型の強制変換、メンバーの呼び出し、リフレクションによる MemberInfo オブジェクトの取得を可能にするオブジェクト。
binder が nullされている場合は、既定のバインダーが使用されます。
- index
- Object[]
インデックス付きプロパティのオプションのインデックス値。 この値は、インデックスのないプロパティに対して null する必要があります。
- culture
- CultureInfo
リソースをローカライズするカルチャ。 リソースがこのカルチャ用にローカライズされていない場合、Parent プロパティは一致を検索して連続して呼び出されます。 この値が nullされている場合、カルチャ固有の情報は CurrentUICulture プロパティから取得されます。
実装
例外
index 配列には、必要な引数の型が含まれていません。
-又は-
プロパティの set アクセサーが見つかりません。
-又は-
value を PropertyTypeの型に変換することはできません。
オブジェクトがターゲットの型と一致しないか、プロパティがインスタンス プロパティですが、obj が null。
index 内のパラメーターの数が、インデックス付きプロパティが受け取るパラメーターの数と一致しません。
クラス内のプライベート メソッドまたは保護されたメソッドに不正にアクセスしようとしました。
プロパティ値の設定中にエラーが発生しました。 たとえば、インデックス付きプロパティに指定されたインデックス値が範囲外です。 InnerException プロパティは、エラーの理由を示します。
注釈
この PropertyInfo オブジェクトが値型で、value が null場合、プロパティはその型の既定値に設定されます。
プロパティにインデックスが付いているかどうかを確認するには、GetIndexParameters メソッドを使用します。 結果の配列に 0 (ゼロ) の要素がある場合、プロパティのインデックスは作成されません。
完全に信頼されたコードでは、アクセス制限は無視されます。 つまり、プライベート コンストラクター、メソッド、フィールド、およびプロパティは、コードが完全に信頼されるたびに Reflection を介してアクセスして呼び出すことができます。
SetValue メソッドを使用するには、最初にクラス Typeを取得します。
Typeから、PropertyInfoを取得します。
PropertyInfoから、SetValue メソッドを使用します。
手記
このメソッドを使用すると、呼び出し元が ReflectionPermission フラグを持つReflectionPermissionFlag.RestrictedMemberAccessを許可されている場合、および非パブリック メンバーの許可セットが呼び出し元の許可セットまたはそのサブセットに制限されている場合に、非パブリック メンバーにアクセスできます。 (「リフレクションのセキュリティに関する考慮事項」を参照してください>)。この機能を使用するには、アプリケーションで Framework 3.5 以降.NETターゲットにする必要があります。