PropertyInfo.GetValue Метод

Определение

Возвращает значение свойства указанного объекта.

Перегрузки

GetValue(Object)

Возвращает значение свойства указанного объекта.

GetValue(Object, Object[])

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

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

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

GetValue(Object)

Возвращает значение свойства указанного объекта.

public:
 System::Object ^ GetValue(System::Object ^ obj);
public object GetValue (object obj);
public object? GetValue (object? obj);
member this.GetValue : obj -> obj
Public Function GetValue (obj As Object) As Object

Параметры

obj
Object

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

Возвращаемое значение

Object

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

Примеры

В следующем примере определяется Planet класс с двумя свойствами: Nameимя планеты и Distanceрасстояние планеты от Земли. В примере создается Planet экземпляр объекта, представляющего планету Юпитер, и он передается методу GetPropertyValues , который отображает сведения о свойствах и использует GetValue метод для получения значения каждого Planet свойства.

using System;
using System.Reflection;

public class Planet
{
   private String planetName;
   private Double distanceFromEarth;
   
   public Planet(String name, Double distance)
   {
      planetName = name;
      distanceFromEarth = distance;
   } 

   public String Name
   { get { return planetName; } }
   
   public Double Distance 
   { get { return distanceFromEarth; }
     set { distanceFromEarth = value; } }
}

public class Example
{
   public static void Main()
   {
      Planet jupiter = new Planet("Jupiter", 3.65e08);
      GetPropertyValues(jupiter);
   }
   
   private static void GetPropertyValues(Object obj)
   {
      Type t = obj.GetType();
      Console.WriteLine("Type is: {0}", t.Name);
      PropertyInfo[] props = t.GetProperties();
      Console.WriteLine("Properties (N = {0}):", 
                        props.Length);
      foreach (var prop in props)
         if (prop.GetIndexParameters().Length == 0)
            Console.WriteLine("   {0} ({1}): {2}", prop.Name,
                              prop.PropertyType.Name,
                              prop.GetValue(obj));
         else
            Console.WriteLine("   {0} ({1}): <Indexed>", prop.Name,
                              prop.PropertyType.Name);
   }
}
// The example displays the following output:
//       Type is: Planet
//       Properties (N = 2):
//          Name (String): Jupiter
//          Distance (Double): 365000000
Imports System.Reflection

Public Class Planet
   Private planetName As String
   Private distanceFromEarth As Double
   
   Public Sub New(name As String, distance As Double)
      planetName = name
      distanceFromEarth = distance
   End Sub 

   Public ReadOnly Property Name As String
      Get
         Return planetName
      End Get
   End Property
   
   Public Property Distance As Double
      Get
         Return distanceFromEarth
      End Get
      Set
         distanceFromEarth = value
      End Set
   End Property
End Class

Module Example
   Public Sub Main()
      Dim jupiter As New Planet("Jupiter", 3.65e08)
      GetPropertyValues(jupiter)
   End Sub
   
   Private Sub GetPropertyValues(obj As Object)
      Dim t As Type = obj.GetType()
      Console.WriteLine("Type is: {0}", t.Name)
      Dim props() As PropertyInfo = t.GetProperties()
      Console.WriteLine("Properties (N = {0}):", 
                        props.Length)
      For Each prop In props
         If prop.GetIndexParameters().Length = 0 Then
            Console.WriteLine("   {0} ({1}): {2}", prop.Name,
                              prop.PropertyType.Name,
                              prop.GetValue(obj))
         Else
            Console.WriteLine("   {0} ({1}): <Indexed>", prop.Name,
                              prop.PropertyType.Name)
         End If                  
      Next                         
   End Sub
End Module
' The example displays the following output:
'       Type is: Planet
'       Properties (N = 2):
'          Name (String): Jupiter
'          Distance (Double): 365000000

Комментарии

Вызывается перегрузка GetValue(Object) для получения значения неиндексированного свойства. При попытке получить значение индексированного свойства метод выдает TargetParameterCountException исключение. Вы можете определить, индексируется ли свойство, путем вызова GetIndexParameters метода. Если длина возвращаемого ParameterInfo массива равна нулю, свойство не индексируется.

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

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

GetValue(Object, Object[])

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

public:
 virtual System::Object ^ GetValue(System::Object ^ obj, cli::array <System::Object ^> ^ index);
public virtual object GetValue (object obj, object[] index);
public virtual object? GetValue (object? obj, object?[]? index);
abstract member GetValue : obj * obj[] -> obj
override this.GetValue : obj * obj[] -> obj
Public Overridable Function GetValue (obj As Object, index As Object()) As Object

Параметры

obj
Object

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

index
Object[]

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

Возвращаемое значение

Object

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

Реализации

Исключения

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

-или- Не найден метод доступа get свойства.

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

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

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

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

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

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

Примеры

В следующем примере показано, как получить значение индексированного свойства. Свойство String.Chars[] является свойством по умолчанию (индексатором в C#) String класса.

using System;
using System.Reflection;

class Example
{
    public static void Main()
    {
        string test = "abcdefghijklmnopqrstuvwxyz";

        // Get a PropertyInfo object representing the Chars property.
        PropertyInfo pinfo = typeof(string).GetProperty("Chars");

        // Show the first, seventh, and last letters
        ShowIndividualCharacters(pinfo, test, 0, 6, test.Length - 1);

        // Show the complete string.
        Console.Write("The entire string: ");
        for (int x = 0; x < test.Length; x++)
        {
            Console.Write(pinfo.GetValue(test, new Object[] {x}));
        }
        Console.WriteLine();
    }

    static void ShowIndividualCharacters(PropertyInfo pinfo, 
                                         object value,
                                         params int[] indexes)
    {
       foreach (var index in indexes) 
          Console.WriteLine("Character in position {0,2}: '{1}'",
                            index, pinfo.GetValue(value, new object[] { index }));
       Console.WriteLine();                          
    }                                      
}
// The example displays the following output:
//    Character in position  0: 'a'
//    Character in position  6: 'g'
//    Character in position 25: 'z'
//    
//    The entire string: abcdefghijklmnopqrstuvwxyz
Imports System.Reflection

Module Example
    Sub Main()
        Dim test As String = "abcdefghijklmnopqrstuvwxyz"

        ' Get a PropertyInfo object representing the Chars property.
        Dim pinfo As PropertyInfo = GetType(String).GetProperty("Chars")

        ' Show the first, seventh, and last characters.
        ShowIndividualCharacters(pinfo, test, { 0, 6, test.Length - 1 })

        ' Show the complete string.
        Console.Write("The entire string: ")
        For x As Integer = 0 To test.Length - 1
            Console.Write(pinfo.GetValue(test, { x }))
        Next
        Console.WriteLine()
    End Sub

    Sub ShowIndividualCharacters(pinfo As PropertyInfo, 
                                 value As Object, 
                                 ParamArray indexes() As Integer)
       For Each index In indexes 
          Console.WriteLine("Character in position {0,2}: '{1}'",
                            index, pinfo.GetValue(value, { index }))
       Next
       Console.WriteLine()                          
    End Sub   
End Module
' The example displays the following output:
'       Character in position  0: 'a'
'       Character in position  6: 'g'
'       Character in position 25: 'z'
'       
'       The entire string: abcdefghijklmnopqrstuvwxyz

Комментарии

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

Это удобный метод, предоставляющий реализацию абстрактного GetValue метода с параметром Default``BindingFlags , Binder заданным значением nullи заданным значением CultureInfo null.

Так как статические свойства относятся к типу, а не отдельным объектам, получают статические свойства, передавая null в качестве аргумента объекта. Например, используйте следующий код, чтобы получить статическое CurrentCulture свойство CultureInfo :

PropertyInfo CurCultProp =   
    (typeof(CultureInfo)).GetProperty("CurrentCulture");   
Console.WriteLine("CurrCult: " +  
    CurCultProp.GetValue(null,null));  

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

Примечание

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

Чтобы использовать эту функцию, приложение должно ориентироваться на платформа .NET Framework 3.5 или более поздней версии.

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

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

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

public:
 abstract System::Object ^ GetValue(System::Object ^ obj, System::Reflection::BindingFlags invokeAttr, System::Reflection::Binder ^ binder, cli::array <System::Object ^> ^ index, System::Globalization::CultureInfo ^ culture);
public abstract object? GetValue (object? obj, System.Reflection.BindingFlags invokeAttr, System.Reflection.Binder? binder, object?[]? index, System.Globalization.CultureInfo? culture);
public abstract object GetValue (object obj, System.Reflection.BindingFlags invokeAttr, System.Reflection.Binder binder, object[] index, System.Globalization.CultureInfo culture);
abstract member GetValue : obj * System.Reflection.BindingFlags * System.Reflection.Binder * obj[] * System.Globalization.CultureInfo -> obj
Public MustOverride Function GetValue (obj As Object, invokeAttr As BindingFlags, binder As Binder, index As Object(), culture As CultureInfo) As Object

Параметры

obj
Object

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

invokeAttr
BindingFlags

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

binder
Binder

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

index
Object[]

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

culture
CultureInfo

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

Возвращаемое значение

Object

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

Реализации

Исключения

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

-или- Не найден метод доступа get свойства.

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

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

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

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

Комментарии

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

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

PropertyInfo CurCultProp =   
       (typeof(CultureInfo)).GetProperty("CurrentCulture");   
Console.WriteLine("CurrCult: " +  
       CurCultProp.GetValue(null,null));  

Чтобы использовать GetValue метод, сначала получите класс Type. С этого Typeфайла получите PropertyInfo. В этом случае PropertyInfoиспользуйте GetValue метод.

Примечание

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

Чтобы использовать эту функцию, приложение должно ориентироваться на платформа .NET Framework 3.5 или более поздней версии.

См. также раздел

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