PropertyInfo Class

July 28, 2014

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

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

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

'Declaration
Public MustInherit Class PropertyInfo _
	Inherits MemberInfo

The PropertyInfo type exposes the following members.

  NameDescription
Public propertyAttributesGets the attributes for this property.
Public propertyCanReadGets a value indicating whether the property can be read.
Public propertyCanWriteGets a value indicating whether the property can be written to.
Public propertyCustomAttributesGets a collection that contains this member's custom attributes. (Inherited from MemberInfo.)
Public propertyDeclaringTypeGets the class that declares this member. (Inherited from MemberInfo.)
Public propertyGetMethodGets the get accessor for this property.
Public propertyIsSpecialNameGets a value indicating whether the name of the property is recognized as a special name by compilers.
Public propertyMemberTypeGets a MemberTypes value indicating that this member is a property. (Overrides MemberInfo.MemberType.)
Public propertyMetadataTokenGets a value that identifies a metadata element. (Inherited from MemberInfo.)
Public propertyModuleGets the module in which the type that declares the member represented by the current MemberInfo is defined. (Inherited from MemberInfo.)
Public propertyNameGets the name of the current member. (Inherited from MemberInfo.)
Public propertyPropertyTypeGets the type of this property.
Public propertyReflectedTypeGets the class object that was used to obtain this instance of MemberInfo. (Inherited from MemberInfo.)
Public propertySetMethodGets the set accessor for this property.
Top

  NameDescription
Public methodEqualsReturns a value that indicates whether this instance is equal to a specified object. (Overrides MemberInfo.Equals(Object).)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetAccessorsReturns an array whose elements reflect the public get, set, and other accessors of the property reflected by the current instance.
Public methodGetAccessors(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.
Public methodGetConstantValueReturns a literal value associated with the property by a compiler.
Public methodGetCustomAttributes(Boolean)When overridden in a derived class, returns an array of all custom attributes applied to this member. (Inherited from MemberInfo.)
Public methodGetCustomAttributes(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.)
Public methodGetGetMethodReturns the public get accessor for this property.
Public methodGetGetMethod(Boolean)When overridden in a derived class, returns the public or non-public get accessor for this property.
Public methodGetHashCodeReturns the hash code for this instance. (Overrides MemberInfo.GetHashCode.)
Public methodGetIndexParametersWhen overridden in a derived class, returns an array of all the index parameters for the property.
Public methodGetRawConstantValueReturns a literal value associated with the property by a compiler.
Public methodGetSetMethodReturns the public set accessor for this property.
Public methodGetSetMethod(Boolean)When overridden in a derived class, returns the set accessor for this property.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetValue(Object)Returns the property value of a specified object.
Public methodGetValue(Object, Object())Returns the value of the property with optional index values for indexed properties.
Public methodGetValue(Object, BindingFlags, Binder, Object(), CultureInfo)When overridden in a derived class, returns the value of a property that has the specified binding, index, and CultureInfo.
Public methodIsDefinedWhen 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.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSetValue(Object, Object)Sets the property value of a specified object.
Public methodSetValue(Object, Object, Object())Sets the value of the property on the specified object, with optional index values for indexed properties.
Public methodSetValue(Object, Object, BindingFlags, Binder, 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.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public Extension MethodGetCustomAttribute(Type)Overloaded. Retrieves a custom attribute of a specified type that is applied to a specified member. (Defined by CustomAttributeExtensions.)
Public Extension MethodGetCustomAttribute(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.)
Public Extension MethodGetCustomAttribute(Of T)Overloaded. Retrieves a custom attribute of a specified type that is applied to a specified member. (Defined by CustomAttributeExtensions.)
Public Extension MethodGetCustomAttribute(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.)
Public Extension MethodGetCustomAttributesOverloaded. Retrieves a collection of custom attributes that are applied to a specified member. (Defined by CustomAttributeExtensions.)
Public Extension MethodGetCustomAttributes(Type)Overloaded. Retrieves a collection of custom attributes of a specified type that are applied to a specified member. (Defined by CustomAttributeExtensions.)
Public Extension MethodGetCustomAttributes(Of T)Overloaded. Retrieves a collection of custom attributes of a specified type that are applied to a specified member. (Defined by CustomAttributeExtensions.)
Public Extension MethodGetCustomAttributes(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.)
Public Extension MethodIsDefinedIndicates whether custom attributes of a specified type are applied to a specified member. (Defined by CustomAttributeExtensions.)
Top

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.

NoteNote:

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.

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


Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

This type is thread safe.

Show:
© 2014 Microsoft