Export (0) Print
Expand All

EventDescriptorCollection Class

Represents a collection of EventDescriptor objects.

System.Object
  System.ComponentModel.EventDescriptorCollection

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

[ComVisibleAttribute(true)]
[HostProtectionAttribute(SecurityAction.LinkDemand, Synchronization = true)]
public class EventDescriptorCollection : IList, 
	ICollection, IEnumerable

The EventDescriptorCollection type exposes the following members.

  NameDescription
Public methodSupported by the XNA FrameworkEventDescriptorCollection(EventDescriptor[])Initializes a new instance of the EventDescriptorCollection class with the given array of EventDescriptor objects.
Public methodEventDescriptorCollection(EventDescriptor[], Boolean)Initializes a new instance of the EventDescriptorCollection class with the given array of EventDescriptor objects. The collection is optionally read-only.
Top

  NameDescription
Public propertySupported by the XNA FrameworkCountGets the number of event descriptors in the collection.
Public propertySupported by the XNA FrameworkItem[Int32]Gets or sets the event with the specified index number.
Public propertySupported by the XNA FrameworkItem[String]Gets or sets the event with the specified name.
Top

  NameDescription
Public methodSupported by the XNA FrameworkAddAdds an EventDescriptor to the end of the collection.
Public methodSupported by the XNA FrameworkClearRemoves all objects from the collection.
Public methodSupported by the XNA FrameworkContainsReturns whether the collection contains the given EventDescriptor.
Public methodSupported by the XNA FrameworkEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodSupported by the XNA FrameworkFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by the XNA FrameworkFindGets the description of the event with the specified name in the collection.
Public methodSupported by the XNA FrameworkGetEnumeratorGets an enumerator for this EventDescriptorCollection.
Public methodSupported by the XNA FrameworkGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodSupported by the XNA FrameworkGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodSupported by the XNA FrameworkIndexOfReturns the index of the given EventDescriptor.
Public methodSupported by the XNA FrameworkInsertInserts an EventDescriptor to the collection at a specified index.
Protected methodInternalSort(IComparer)Sorts the members of this EventDescriptorCollection, using the specified IComparer.
Protected methodInternalSort(String[])Sorts the members of this EventDescriptorCollection. The specified order is applied first, followed by the default sort for this collection, which is usually alphabetical.
Protected methodSupported by the XNA FrameworkMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by the XNA FrameworkRemoveRemoves the specified EventDescriptor from the collection.
Public methodSupported by the XNA FrameworkRemoveAtRemoves the EventDescriptor at the specified index from the collection.
Public methodSort()Sorts the members of this EventDescriptorCollection, using the default sort for this collection, which is usually alphabetical.
Public methodSort(IComparer)Sorts the members of this EventDescriptorCollection, using the specified IComparer.
Public methodSort(String[])Sorts the members of this EventDescriptorCollection, given a specified sort order.
Public methodSort(String[], IComparer)Sorts the members of this EventDescriptorCollection, given a specified sort order and an IComparer.
Public methodSupported by the XNA FrameworkToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public Extension MethodAsParallelEnables parallelization of a query. (Defined by ParallelEnumerable.)
Public Extension MethodAsQueryableConverts an IEnumerable to an IQueryable. (Defined by Queryable.)
Public Extension MethodSupported by the XNA FrameworkCast<TResult>Casts the elements of an IEnumerable to the specified type. (Defined by Enumerable.)
Public Extension MethodSupported by the XNA FrameworkOfType<TResult>Filters the elements of an IEnumerable based on a specified type. (Defined by Enumerable.)
Top

  NameDescription
Public fieldStatic memberSupported by the XNA FrameworkEmptySpecifies an empty collection to use, rather than creating a new one with no items. This static field is read-only.
Top

  NameDescription
Explicit interface implemetationPrivate methodSupported by the XNA FrameworkICollection.CopyToCopies the elements of the collection to an Array, starting at a particular Array index.
Explicit interface implemetationPrivate propertySupported by the XNA FrameworkICollection.CountGets the number of elements contained in the collection.
Explicit interface implemetationPrivate propertySupported by the XNA FrameworkICollection.IsSynchronizedGets a value indicating whether access to the collection is synchronized.
Explicit interface implemetationPrivate propertySupported by the XNA FrameworkICollection.SyncRootGets an object that can be used to synchronize access to the collection.
Explicit interface implemetationPrivate methodSupported by the XNA FrameworkIEnumerable.GetEnumeratorReturns an enumerator that iterates through a collection.
Explicit interface implemetationPrivate methodSupported by the XNA FrameworkIList.AddAdds an item to the collection.
Explicit interface implemetationPrivate methodSupported by the XNA FrameworkIList.ClearRemoves all the items from the collection.
Explicit interface implemetationPrivate methodSupported by the XNA FrameworkIList.ContainsDetermines whether the collection contains a specific value.
Explicit interface implemetationPrivate methodSupported by the XNA FrameworkIList.IndexOfDetermines the index of a specific item in the collection.
Explicit interface implemetationPrivate methodSupported by the XNA FrameworkIList.InsertInserts an item to the collection at the specified index.
Explicit interface implemetationPrivate propertySupported by the XNA FrameworkIList.IsFixedSizeGets a value indicating whether the collection has a fixed size.
Explicit interface implemetationPrivate propertySupported by the XNA FrameworkIList.IsReadOnlyGets a value indicating whether the collection is read-only.
Explicit interface implemetationPrivate propertySupported by the XNA FrameworkIList.ItemGets or sets the element at the specified index.
Explicit interface implemetationPrivate methodSupported by the XNA FrameworkIList.RemoveRemoves the first occurrence of a specific object from the collection.
Explicit interface implemetationPrivate methodSupported by the XNA FrameworkIList.RemoveAtRemoves the item at the specified index.
Top

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 type or member 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';
 }

.NET Framework

Supported in: 4.5.2, 4.5.1, 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.1, Windows Server 2012 R2, 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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft