System.Reflection.PropertyInfo Class

public abstract class PropertyInfo : MemberInfo

Base Types

Object
  MemberInfo
    PropertyInfo

Assembly

mscorlib

Library

Reflection

Summary

Provides access to property metadata.

Description

A property is a named aspect of an object's state whose value is typically accessible through Get and Set accessors. [Note: Properties can be read-only, in which case the Set accessor is not available.]

Several methods in this class assume that the Get and Set accessors of a property have certain formats. The signatures of the accessors are required to match the following conventions:

• The return type of the Get accessor and the last argument of the Set accessor are required to be identical to the type of the property reflected by the current instance.
• The Get and Set accessors are required to have the same number, type, and order of indices.

If this format is not followed, the behavior of the System.Reflection.PropertyInfo.GetValue(System.Object,System.Object[]) and System.Reflection.PropertyInfo.SetValue(System.Object,System.Object,System.Object[]) methods is undefined.

See Also

System.Reflection Namespace

Members

PropertyInfo Constructors

PropertyInfo Constructor

PropertyInfo Methods

PropertyInfo.GetAccessors(bool) Method
PropertyInfo.GetAccessors() Method
PropertyInfo.GetGetMethod(bool) Method
PropertyInfo.GetGetMethod() Method
PropertyInfo.GetIndexParameters Method
PropertyInfo.GetSetMethod(bool) Method
PropertyInfo.GetSetMethod() Method
PropertyInfo.GetValue(System.Object, System.Reflection.BindingFlags, System.Reflection.Binder, System.Object[], System.Globalization.CultureInfo) Method
PropertyInfo.GetValue(System.Object, System.Object[]) Method
PropertyInfo.SetValue(System.Object, System.Object, System.Reflection.BindingFlags, System.Reflection.Binder, System.Object[], System.Globalization.CultureInfo) Method
PropertyInfo.SetValue(System.Object, System.Object, System.Object[]) Method

PropertyInfo Properties

PropertyInfo.Attributes Property
PropertyInfo.CanRead Property
PropertyInfo.CanWrite Property
PropertyInfo.PropertyType Property

Constructs a new instance of the PropertyInfo class.

See Also

System.Reflection.PropertyInfo Class, System.Reflection Namespace

nonPublic

A Boolean value that indicates whether non-public accessors will be included in the return value. Specify true to include the non-public accessors; otherwise, specify false .

Return Value

An array of MethodInfo objects whose elements reflect the Get , Set , and other accessors of the property reflected by the current instance. If nonPublic is true , this array contains public and non-public accessors. If nonPublic is false , this array contains only public accessors. If no accessors with the specified visibility are found, returns an array with zero elements.

Description

[Behaviors: As described above.]

See Also

System.Reflection.PropertyInfo Class, System.Reflection Namespace

An array of MethodInfo objects that reflect the public Get , Set , and other accessors of the property reflected by the current instance, if found; otherwise, returns an array with zero elements.

Description

This method is equivalent to System.Reflection.PropertyInfo.GetAccessors(false ).

See Also

System.Reflection.PropertyInfo Class, System.Reflection Namespace

nonPublic

A Boolean value that indicates whether a non-public Get accessor will be returned. Specify true to allow a non-public accessor; otherwise, specify false .

Return Value

If nonPublic is true , returns a MethodInfo instance that reflects the Get accessor for the property reflected by the current instance if that accessor exists. If nonPublic is false and the Get accessor is non-public, or nonPublic is true but no Get accessor exists for the property reflected by the current instance, returns null .

Exceptions

Exception Type	Condition
MethodAccessException	nonPublic is true , the Get accessor for the property reflected by the current instance is non-public, and the caller does not have ReflectionPermission to reflect on non-public methods.

Description

[Behaviors: As described above.]

See Also

System.Reflection.PropertyInfo Class, System.Reflection Namespace

A MethodInfo instance that reflects the public Get accessor for the property reflected by the current instance. Returns null if no public Get accessor exists.

See Also

System.Reflection.PropertyInfo Class, System.Reflection Namespace

An array of ParameterInfo objects that reflect the indexers of the property reflected by the current instance. If no indexers exist for the property reflected by the current instance, returns an array with zero elements.

Exceptions

Exception Type	Condition
MethodAccessException	The property reflected by the current instance is visible, but its Get and Set accessors are not, and the caller does not have ReflectionPermission.

Description

[Behaviors: As described above.]

See Also

System.Reflection.PropertyInfo Class, System.Reflection Namespace

nonPublic

A Boolean value that indicates whether a non-public Set accessor will be returned. Specify true to allow a non-public accessor; otherwise, specify false .

Return Value

If nonPublic is true , returns a MethodInfo instance that reflects the Set accessor for the property reflected by the current instance if that accessor exists. If nonPublic is false and the Set accessor is non-public, or nonPublic is true but no Set accessor exists for the property reflected by the current instance, returns null .

Exceptions

Exception Type	Condition
MethodAccessException	nonPublic is true , the Set accessor for the property reflected by the current instance is non-public, and the caller does not have ReflectionPermission to reflect on non-public methods.

Description

[Behaviors: As described above.]

See Also

System.Reflection.PropertyInfo Class, System.Reflection Namespace

A MethodInfo instance that reflects the public Set accessor for the property reflected by the current instance. Returns null if no public Set accessor exists.

Description

This method is equivalent to System.Reflection.PropertyInfo.GetSetMethod(false ).

See Also

System.Reflection.PropertyInfo Class, System.Reflection Namespace

obj

The object whose property value is returned. Specify null to invoke a static Get accessor on the property reflected by the current instance.

invokeAttr

A BindingFlags value that controls the binding process. [Note: Specify System.Reflection.BindingFlags.Public or System.Reflection.BindingFlags.NonPublic, and System.Reflection.BindingFlags.Instance or System.Reflection.BindingFlags.Static; or this method will not invoke any get accessors of the property reflected by the current instance.]

binder

A Binder that enables the binding, coercion of argument types, invocation of members, and retrieval of MemberInfo objects via reflection. If binder is null , the default binder is used.

index

An array of objects that is an index or values for indexed properties. This value is required to be null for non-indexed properties.

culture

The only defined value for this parameter is null .

Return Value

A Object that contains the property value for obj .

Exceptions

Exception Type	Condition
ArgumentException	index does not contain the exact type of arguments needed. -or- The Get accessor of the property reflected by the current instance was not found.
MethodAccessException	The Get accessor of the property reflected by the current instance is non-public and the caller does not have ReflectionPermission to reflect on non-public methods.
TargetException	The property reflected by the current instance is non-static, and obj is null or is of a type that does not implement the property reflected by the current instance.
TargetParameterCountException	The current instance reflects an indexer and index.Length does not equal the rank of the indexer.

Description

[Behaviors: As described above.]

See Also

System.Reflection.PropertyInfo Class, System.Reflection Namespace

A Object that contains the property value for obj .

Exceptions

Exception Type	Condition
ArgumentException	index does not contain the exact type of arguments needed. -or- The Get accessor of the property reflected by the current instance is not found.
MethodAccessException	The Get accessor of the property reflected by the current instance is non-public and the caller does not have ReflectionPermission to reflect on non-public methods.
TargetException	The property reflected by the current instance is non-static, and obj is null or is of a type that does not implement the property reflected by the current instance.
TargetParameterCountException	The current instance reflects an indexer and index.Length does not equal the rank of the indexer.

Description

[Behaviors: As described above.]

See Also

System.Reflection.PropertyInfo Class, System.Reflection Namespace

obj

The object whose property value is returned. Specify null to invoke a static Set accessor on the property reflected by the current instance.

value

A object that contains the new value for the property.

invokeAttr

A BindingFlags value that controls the binding process. [Note: Specify System.Reflection.BindingFlags.Public or System.Reflection.BindingFlags.NonPublic, and System.Reflection.BindingFlags.Instance or System.Reflection.BindingFlags.Static; otherwise, this method will not invoke any Set accessors of the property reflected by the current instance.]

binder

A Binder that enables the binding, coercion of argument types, invocation of members, and retrieval of MemberInfo objects via reflection. If binder is null , the default binder is used.

index

An array of objects that is an index or values for indexed properties. This value is required to be null for non-indexed properties.

culture

The only defined value for this parameter is null .

Exceptions

Exception Type	Condition
ArgumentException	The index array does not contain the exact type of arguments needed. The Set accessor of the property reflected by the current instance is not found.
TargetException	The property reflected by the current instance is non-static, and obj is null or is of a type that does not implement the property reflected by the current instance.
MethodAccessException	The Set accessor of the property reflected by the current instance is non-public and the caller does not have ReflectionPermission to reflect on non-public methods.
TargetParameterCountException	The current instance reflects an indexer and index.Length does not equal the rank of the indexer.

Description

[Behaviors: As described above.]

See Also

System.Reflection.PropertyInfo Class, System.Reflection Namespace

System.Reflection.PropertyInfo Class, System.Reflection Namespace

A PropertyAttributes value that specifies the attributes of the property reflected by the current instance.

Description

[Behaviors: This property is read-only.

This property gets a PropertyAttributes value that indicates the attributes set in the metadata of the property reflected by the current instance.

]

[Usage: Use this property to determine if the property reflected by the current instance has a special name or a default value.]

See Also

System.Reflection.PropertyInfo Class, System.Reflection Namespace

Gets a Boolean value indicating whether the property reflected by the current instance has a Get accessor.

Property Value

true if the property reflected by the current instance has a Get accessor; otherwise, false .

Description

[Behaviors: This property is read-only.]

See Also

System.Reflection.PropertyInfo Class, System.Reflection Namespace

Gets a Boolean value indicating whether the property reflected by the current instance has a Set accessor.

Property Value

true if the property reflected by the current instance has a Set accessor; otherwise, false .

Description

[Behaviors: This property is read-only.]

See Also

System.Reflection.PropertyInfo Class, System.Reflection Namespace

A Type that represents the type of the property reflected by the current instance.

Description

[Behaviors: This property is read-only.]

See Also

System.Reflection.PropertyInfo Class, System.Reflection Namespace