Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

EventDescriptorCollection Class

Represents a collection of EventDescriptor objects.

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

[ComVisibleAttribute(true)] 
public class EventDescriptorCollection : IList, ICollection, IEnumerable
/** @attribute ComVisibleAttribute(true) */ 
public class EventDescriptorCollection implements IList, ICollection, 
	IEnumerable
ComVisibleAttribute(true) 
public class EventDescriptorCollection implements IList, ICollection, 
	IEnumerable
Not applicable.

EventDescriptorCollection is read-only; it does not implement methods that add or remove events. You must inherit from this class to implement these methods.

Using the properties available in the EventDescriptorCollection class, you can query the collection about its contents. Use the Count property to determine the number of elements in the collection. Use the Item property to get a specific property by index number or by name.

You can also use the Find method to get a description of the event with the specified name from the collection.

NoteNote:

The HostProtectionAttribute attribute applied to this class has the following Resources property value: Synchronization. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

The following code example prints all the events on a button in a text box. It requires that button1 and textBox1 have been instantiated on a form.

private void MyEventCollection() {
    // Creates a new collection and assigns it the events for button1.
    EventDescriptorCollection events = TypeDescriptor.GetEvents(button1);
 
    // Displays each event in the collection in a text box.
    foreach (EventDescriptor myEvent in events)
       textBox1.Text += myEvent.Name + '\n';
 }


private void MyEventCollection()
{
    // Creates a new collection and assigns it the events for button1.
    EventDescriptorCollection events = TypeDescriptor.GetEvents(button1);

    for (int iCtr = 0; iCtr < events.get_Count(); iCtr++) {
        EventDescriptor myEvent = events.get_Item(iCtr);
        // Displays each event in the collection in a text box.
        textBox1.set_Text(textBox1.get_Text() + myEvent.get_Name() + '\n');
    }
} //MyEventCollection

System.Object
  System.ComponentModel.EventDescriptorCollection
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.