PropertyInfo Class

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Discovers the attributes of a property and provides access to property metadata.

Inheritance Hierarchy

System..::.Object
System.Reflection..::.MemberInfo
System.Reflection..::.PropertyInfo

Namespace: System.Reflection
Assembly: mscorlib (in mscorlib.dll)

Syntax

Public MustInherit Class PropertyInfo _
    Inherits MemberInfo
public abstract class PropertyInfo : MemberInfo

The PropertyInfo type exposes the following members.

Properties

Name Description
Attributes Gets the attributes for this property.
CanRead Gets a value indicating whether the property can be read.
CanWrite Gets a value indicating whether the property can be written to.
CustomAttributes Gets a collection that contains this member's custom attributes. (Inherited from MemberInfo.)
DeclaringType Gets the class that declares this member. (Inherited from MemberInfo.)
GetMethod Gets the get accessor for this property.
IsSpecialName Gets a value indicating whether the name of the property is recognized as a special name by compilers.
MemberType Gets a MemberTypes value indicating that this member is a property. (Overrides MemberInfo..::.MemberType.)
MetadataToken Gets a value that identifies a metadata element. (Inherited from MemberInfo.)
Module Gets the module in which the type that declares the member represented by the current MemberInfo is defined. (Inherited from MemberInfo.)
Name Gets the name of the current member. (Inherited from MemberInfo.)
PropertyType Gets the type of this property.
ReflectedType Gets the class object that was used to obtain this instance of MemberInfo. (Inherited from MemberInfo.)
SetMethod Gets the set accessor for this property.

Top

Methods

Name Description
Equals Returns a value that indicates whether this instance is equal to a specified object. (Overrides MemberInfo..::.Equals(Object).)
Finalize Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
GetAccessors()()() Returns an array whose elements reflect the public get, set, and other accessors of the property reflected by the current instance.
GetAccessors(Boolean) Returns an array whose elements reflect the public (and, if specified, non-public) get, set, and other accessors of the property reflected by the current instance.
GetConstantValue Returns a literal value associated with the property by a compiler.
GetCustomAttributes(Boolean) When overridden in a derived class, returns an array of all custom attributes applied to this member. (Inherited from MemberInfo.)
GetCustomAttributes(Type, Boolean) When overridden in a derived class, returns an array of custom attributes applied to this member and identified by Type. (Inherited from MemberInfo.)
GetGetMethod()()() Returns the public get accessor for this property.
GetGetMethod(Boolean) When overridden in a derived class, returns the public or non-public get accessor for this property.
GetHashCode Returns the hash code for this instance. (Overrides MemberInfo..::.GetHashCode()()().)
GetIndexParameters When overridden in a derived class, returns an array of all the index parameters for the property.
GetRawConstantValue Returns a literal value associated with the property by a compiler.
GetSetMethod()()() Returns the public set accessor for this property.
GetSetMethod(Boolean) When overridden in a derived class, returns the set accessor for this property.
GetType Gets the Type of the current instance. (Inherited from Object.)
GetValue(Object) Returns the property value of a specified object.
GetValue(Object, array<Object>[]()[]) Returns the value of the property with optional index values for indexed properties.
GetValue(Object, BindingFlags, Binder, array<Object>[]()[], CultureInfo) When overridden in a derived class, returns the value of a property that has the specified binding, index, and CultureInfo.
IsDefined When overridden in a derived class, indicates whether one or more attributes of the specified type or of its derived types is applied to this member. (Inherited from MemberInfo.)
MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
SetValue(Object, Object) Sets the property value of a specified object.
SetValue(Object, Object, array<Object>[]()[]) Sets the value of the property on the specified object, with optional index values for indexed properties.
SetValue(Object, Object, BindingFlags, Binder, array<Object>[]()[], CultureInfo) When overridden in a derived class, sets the property value for the given object to the given value, subject to the specified binding constraints, binder, and culture.
ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Extension Methods

Name Description
GetCustomAttribute(Type) Overloaded. Retrieves a custom attribute of a specified type that is applied to a specified member. (Defined by CustomAttributeExtensions.)
GetCustomAttribute(Type, Boolean) Overloaded. Retrieves a custom attribute of a specified type that is applied to a specified member, and optionally inspects the ancestors of that member. (Defined by CustomAttributeExtensions.)
GetCustomAttribute<(Of <(T>)>)()()() Overloaded. Retrieves a custom attribute of a specified type that is applied to a specified member. (Defined by CustomAttributeExtensions.)
GetCustomAttribute<(Of <(T>)>)(Boolean) Overloaded. Retrieves a custom attribute of a specified type that is applied to a specified member, and optionally inspects the ancestors of that member. (Defined by CustomAttributeExtensions.)
GetCustomAttributes()()() Overloaded. Retrieves a collection of custom attributes that are applied to a specified member. (Defined by CustomAttributeExtensions.)
GetCustomAttributes(Type) Overloaded. Retrieves a collection of custom attributes of a specified type that are applied to a specified member. (Defined by CustomAttributeExtensions.)
GetCustomAttributes<(Of <(T>)>)()()() Overloaded. Retrieves a collection of custom attributes of a specified type that are applied to a specified member. (Defined by CustomAttributeExtensions.)
GetCustomAttributes<(Of <(T>)>)(Boolean) Overloaded. Retrieves a collection of custom attributes of a specified type that are applied to a specified member, and optionally inspects the ancestors of that member. (Defined by CustomAttributeExtensions.)
IsDefined Indicates whether custom attributes of a specified type are applied to a specified member. (Defined by CustomAttributeExtensions.)

Top

Remarks

Properties are logically the same as fields. A property is a named aspect of an object's state whose value is typically accessible through get and set accessors. Properties may be read-only, in which case there is no set accessor.

Note

To determine whether a property is static, you must obtain the MethodInfo for the get or set accessor, by calling the GetGetMethod or the GetSetMethod method, and examine its IsStatic property.

Calling ICustomAttributeProvider..::.GetCustomAttributes on PropertyInfo and specifying true for the inherit parameter does not walk the type hierarchy. Use the Attribute..::.GetCustomAttributes(MemberInfo, Boolean) method to list inherited custom attributes. Note, however, that even this method finds only those inherited custom attributes that derive from System..::.Attribute.

Examples

The following example shows how to get the value of an indexed property using reflection. The String..::.Chars property is the default property (the indexer in C#) of the String class.

Imports System.Reflection

Class Example

   Public Shared Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock) 

        Dim test As String = "abcdefghijklmnopqrstuvwxyz"

        ' To retrieve the value of the indexed Chars property  using 
        ' reflection, create an instance of PropertyInfo for Chars.
        '
        Dim pinfo As PropertyInfo = GetType(String).GetProperty("Chars")

        ' To retrieve an instance property, the GetValue method
        ' requires the object whose property is being accessed, and 
        ' an array of objects representing the index values. 

        ' Get the seventh character in the test string. 
        ' Note that the index is zero-based.
        Dim indexArgs() As Object = { 6 }
        Dim value As Object = pinfo.GetValue(test, indexArgs)
        outputBlock.Text &= _
            String.Format("The character at index 6 is ""{0}""." & vbLf, value)

        ' Show the complete string, one character at a time.
        For i As Integer = 0 To test.Length - 1
            outputBlock.Text &= pinfo.GetValue(test, New Object() { i })
        Next
        outputBlock.Text &= vbLf

    End Sub

End Class

' This example produces the following output:
'
'The character at index 6 is "g".
'abcdefghijklmnopqrstuvwxyz
using System;
using System.Reflection;

class Example
{
    public static void Demo(System.Windows.Controls.TextBlock outputBlock)
    {
        string test = "abcdefghijklmnopqrstuvwxyz";

        // To retrieve the value of the indexed Chars property  using 
        // reflection, create an instance of PropertyInfo for Chars.
        //
        PropertyInfo pinfo = typeof(string).GetProperty("Chars");

        // To retrieve an instance property, the GetValue method
        // requires the object whose property is being accessed, and 
        // an array of objects representing the index values. 

        // Get the seventh character in the test string. 
        // Note that the index is zero-based.
        object[] indexArgs = { 6 };
        object value = pinfo.GetValue(test, indexArgs);
        outputBlock.Text += 
            String.Format("The character at index 6 is \"{0}\".\n", value);

        // Show the complete string, one character at a time.
        for(int i = 0; i < test.Length; i++)
        {
            outputBlock.Text += pinfo.GetValue(test, new object[] { i });
        }
        outputBlock.Text += "\n";
    }
}

/* This example produces the following output:

The character at index 6 is "g".
abcdefghijklmnopqrstuvwxyz
 */

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

Thread Safety

This type is thread safe.

See Also

Reference

System.Reflection Namespace