This topic has not yet been rated - Rate this topic

TypeDescriptor.GetEvents Method (Object, Attribute[])

Returns the collection of events for a specified component using a specified array of attributes as a filter.

Namespace:  System.ComponentModel
Assembly:  System (in System.dll)
public static EventDescriptorCollection GetEvents(
	Object component,
	Attribute[] attributes
)

Parameters

component
Type: System.Object

A component to get the events for.

attributes
Type: System.Attribute[]

An array of type Attribute that you can use as a filter.

Return Value

Type: System.ComponentModel.EventDescriptorCollection
An EventDescriptorCollection with the events that match the specified attributes for this component.
ExceptionCondition
NotSupportedException

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

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Did you find this helpful?
(1500 characters remaining)
© 2013 Microsoft. All rights reserved.