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


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 events 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)

public static EventDescriptorCollection GetEvents(
	object component,
	Attribute[] attributes,
	bool noCustomTypeDesc


Type: System.Object

A component to get the events for.

Type: System.Attribute[]

An array of type Attribute to use as a filter.

Type: System.Boolean

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

Return Value

Type: System.ComponentModel.EventDescriptorCollection

An EventDescriptorCollection with the events that match the specified attributes for this component.

Exception Condition

component is a cross-process remoted object.

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

The attributes parameter array can have a mix of Type and Attribute objects. Filtering is defined by the following rules:

  • A Type is treated as a wildcard; it matches any event that has the Type in its set of attributes.

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

  • If the attribute is an instance of the Attribute class, the event 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 event, it is included in the returned array even if there is no instance of the Attribute in the event.

If component 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