This topic has not yet been rated - Rate this topic

EventInfo Class

Discovers the attributes of an event and provides access to event metadata.

Namespace:  System.Reflection
Assembly:  mscorlib (in mscorlib.dll)
[SerializableAttribute]
[ClassInterfaceAttribute(ClassInterfaceType.None)]
[ComVisibleAttribute(true)]
[PermissionSetAttribute(SecurityAction.InheritanceDemand, Name = "FullTrust")]
public abstract class EventInfo : MemberInfo, 
	_EventInfo

The EventInfo type exposes the following members.

  Name Description
Protected method Supported by the XNA Framework EventInfo Initializes a new instance of the EventInfo class.
Top
  Name Description
Public property Supported by the XNA Framework Attributes Gets the attributes for this event.
Public property Supported by the XNA Framework Supported by Portable Class Library DeclaringType Gets the class that declares this member. (Inherited from MemberInfo.)
Public property Supported by the XNA Framework Supported by Portable Class Library EventHandlerType Gets the Type object of the underlying event-handler delegate associated with this event.
Public property Supported by the XNA Framework Supported by Portable Class Library IsMulticast Gets a value indicating whether the event is multicast.
Public property Supported by the XNA Framework Supported by Portable Class Library IsSpecialName Gets a value indicating whether the EventInfo has a name with a special meaning.
Public property Supported by the XNA Framework Supported by Portable Class Library MemberType Gets a MemberTypes value indicating that this member is an event. (Overrides MemberInfo.MemberType.)
Public property MetadataToken Gets a value that identifies a metadata element. (Inherited from MemberInfo.)
Public property Supported by Portable Class Library Module Gets the module in which the type that declares the member represented by the current MemberInfo is defined. (Inherited from MemberInfo.)
Public property Supported by the XNA Framework Supported by Portable Class Library Name Gets the name of the current member. (Inherited from MemberInfo.)
Public property Supported by the XNA Framework Supported by Portable Class Library ReflectedType Gets the class object that was used to obtain this instance of MemberInfo. (Inherited from MemberInfo.)
Top
  Name Description
Public method Supported by the XNA Framework Supported by Portable Class Library AddEventHandler Adds an event handler to an event source.
Public method Supported by the XNA Framework Supported by Portable Class Library Equals Returns a value that indicates whether this instance is equal to a specified object. (Overrides MemberInfo.Equals(Object).)

In XNA Framework 3.0, this member is inherited from Object.Equals(Object).


In Portable Class Library Portable Class Library, this member is inherited from Object.Equals(Object).
Protected method Supported by the XNA Framework Supported by Portable Class Library Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method Supported by the XNA Framework Supported by Portable Class Library GetAddMethod() Returns the method used to add an event handler delegate to the event source.
Public method Supported by the XNA Framework Supported by Portable Class Library GetAddMethod(Boolean) When overridden in a derived class, retrieves the MethodInfo object for the AddEventHandler method of the event, specifying whether to return non-public methods.
Public method Supported by the XNA Framework Supported by Portable Class Library GetCustomAttributes(Boolean) When overridden in a derived class, returns an array of all custom attributes applied to this member. (Inherited from MemberInfo.)
Public method Supported by the XNA Framework Supported by Portable Class Library GetCustomAttributes(Type, Boolean) When overridden in a derived class, returns an array of custom attributes applied to this member and identified by Type. (Inherited from MemberInfo.)
Public method GetCustomAttributesData Returns a list of CustomAttributeData objects representing data about the attributes that have been applied to the target member. (Inherited from MemberInfo.)
Public method Supported by the XNA Framework Supported by Portable Class Library GetHashCode Returns the hash code for this instance. (Overrides MemberInfo.GetHashCode().)

In XNA Framework 3.0, this member is inherited from Object.GetHashCode().


In Portable Class Library Portable Class Library, this member is inherited from Object.GetHashCode().
Public method GetOtherMethods() Returns the public methods that have been associated with an event in metadata using the .other directive.
Public method GetOtherMethods(Boolean) Returns the methods that have been associated with the event in metadata using the .other directive, specifying whether to include non-public methods.
Public method Supported by the XNA Framework Supported by Portable Class Library GetRaiseMethod() Returns the method that is called when the event is raised.
Public method Supported by the XNA Framework Supported by Portable Class Library GetRaiseMethod(Boolean) When overridden in a derived class, returns the method that is called when the event is raised, specifying whether to return non-public methods.
Public method Supported by the XNA Framework Supported by Portable Class Library GetRemoveMethod() Returns the method used to remove an event handler delegate from the event source.
Public method Supported by the XNA Framework Supported by Portable Class Library GetRemoveMethod(Boolean) When overridden in a derived class, retrieves the MethodInfo object for removing a method of the event, specifying whether to return non-public methods.
Public method Supported by the XNA Framework Supported by Portable Class Library GetType Gets the Type of the current instance. (Inherited from Object.)
Public method Supported by the XNA Framework Supported by Portable Class Library IsDefined When overridden in a derived class, indicates whether one or more attributes of the specified type or of its derived types is applied to this member. (Inherited from MemberInfo.)
Protected method Supported by the XNA Framework Supported by Portable Class Library MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Supported by the XNA Framework Supported by Portable Class Library RemoveEventHandler Removes an event handler from an event source.
Public method Supported by the XNA Framework Supported by Portable Class Library ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Public operator Static member Equality Indicates whether two EventInfo objects are equal.
Public operator Static member Inequality Indicates whether two EventInfo objects are not equal.
Top
  Name Description
Explicit interface implemetation Private method _EventInfo.GetIDsOfNames Maps a set of names to a corresponding set of dispatch identifiers.
Explicit interface implemetation Private method _EventInfo.GetType Returns a T:System.Type object representing the EventInfo type.
Explicit interface implemetation Private method _EventInfo.GetTypeInfo Retrieves the type information for an object, which can then be used to get the type information for an interface.
Explicit interface implemetation Private method _EventInfo.GetTypeInfoCount Retrieves the number of type information interfaces that an object provides (either 0 or 1).
Explicit interface implemetation Private method _EventInfo.Invoke Provides access to properties and methods exposed by an object.
Explicit interface implemetation Private method _MemberInfo.GetIDsOfNames Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from MemberInfo.)
Explicit interface implemetation Private method _MemberInfo.GetType Gets a Type object representing the MemberInfo class. (Inherited from MemberInfo.)
Explicit interface implemetation Private method _MemberInfo.GetTypeInfo Retrieves the type information for an object, which can then be used to get the type information for an interface. (Inherited from MemberInfo.)
Explicit interface implemetation Private method _MemberInfo.GetTypeInfoCount Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from MemberInfo.)
Explicit interface implemetation Private method _MemberInfo.Invoke Provides access to properties and methods exposed by an object. (Inherited from MemberInfo.)
Top

Use the EventInfo class to inspect events and to hook up event handlers, as shown in the example code for the AddEventHandler method.

Note Note

EventInfo is not intended to be used to raise events. An object raises events as dictated by its internal state.

Events are used with delegates. An event listener instantiates an event-handler delegate that is invoked whenever the event is raised by an event source. In order to connect to the event source, the event listener adds this delegate to the invocation list on the source. When the event is raised, the invoke method of the event-handler delegate is called. Both multicast and single-cast event notifications are supported. The Add and Remove methods, as well as the event-handler delegate class associated with an event, must be marked in the metadata.

Delegates are object-oriented function pointers. In C or C++, a function pointer is a reference to a method. In contrast to the C or C++ function pointer, a delegate contains two references: a reference to a method and a reference to an object that supports the method. Delegates can invoke a method without knowing the class type that declares or inherits the method. Delegates need only know the return type and parameter list of the method.

The event model works equally well for single-cast and multicast delegates. When the delegate's invoke method is called, only a single object will have a method called on it. A multicast modifier can be applied to a delegate declaration, which allows multiple methods to be called when the invoke method of the delegate is called.

Calling ICustomAttributeProvider.GetCustomAttributes on EventInfo when the inherit parameter of GetCustomAttributes is true does not walk the type hierarchy. Use System.Attribute to inherit custom attributes.

Notes to Inheritors

When you inherit from EventInfo, you must override the following members: GetAddMethod, GetRemoveMethod, and GetRaiseMethod.

The following code gets an EventInfo object for the Click event of the Button class.


using System;
using System.Reflection;
using System.Security;

class MyEventExample
{
    public static void Main()
    {  
        try
        {

            // Creates a bitmask based on BindingFlags.
            BindingFlags myBindingFlags = BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic;
            Type myTypeBindingFlags = typeof(System.Windows.Forms.Button);
            EventInfo myEventBindingFlags = myTypeBindingFlags.GetEvent("Click", myBindingFlags);
            if(myEventBindingFlags != null)
            {
                Console.WriteLine("Looking for the Click event in the Button class with the specified BindingFlags.");
                Console.WriteLine(myEventBindingFlags.ToString());
            }
            else
                Console.WriteLine("The Click event is not available with the Button class.");
        }
        catch(SecurityException e)
        {
            Console.WriteLine("An exception occurred.");
            Console.WriteLine("Message :"+e.Message);
        }
        catch(ArgumentNullException e)
        {
            Console.WriteLine("An exception occurred.");
            Console.WriteLine("Message :"+e.Message);
        }
        catch(Exception e)
        {
            Console.WriteLine("The following exception was raised : {0}",e.Message);
        }
    }
}


.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

This type is thread safe.

Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ