TypeDescriptor.GetProperties Method (Object, Attribute[], Boolean)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Returns the collection of properties for a specified component using a specified array of attributes as a filter and using a custom type descriptor.

Namespace:   System.ComponentModel
Assembly:  System (in System.dll)

static member GetProperties : 
        component:Object *
        attributes:Attribute[] *
        noCustomTypeDesc:bool -> PropertyDescriptorCollection

Parameters

component
Type: System.Object

A component to get the properties for.

attributes
Type: System.Attribute[]

An array of type Attribute to use as a filter.

noCustomTypeDesc
Type: System.Boolean

true to consider custom type description information; otherwise, false.

Return Value

Type: System.ComponentModel.PropertyDescriptorCollection

A PropertyDescriptorCollection with the events that match the specified attributes for the specified component.

Exception Condition
NotSupportedException

component is a cross-process remoted object.

The properties for a component can differ from the properties of a class, because the site can add or remove properties if the component is sited.

The attributes parameter array is used to filter the array. Filtering is defined by the following rules:

  • If a property does not have an Attribute of the same class, the property is not included in the returned array.

  • If the attribute is an instance of the Attribute class, the property must be an exact match or it is not included in the returned array.

  • If an Attribute instance is specified and it is the default property, it is included in the returned array even if there is no instance of the Attribute in the property.

  • If attributes has a default attribute, the GetProperties method matches the case when the property does not have the attribute applied.

If the component parameter is null, an empty collection is returned.

The order of the returned collection is not guaranteed to be identical between calls, so always order it before use.

.NET Framework
Available since 1.1
Return to top
Show: