CodeAttachEventStatement Class


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Represents a statement that attaches an event-handler delegate to an event.

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


public ref class CodeAttachEventStatement : CodeStatement


Initializes a new instance of the CodeAttachEventStatement class.

System_CAPS_pubmethodCodeAttachEventStatement(CodeEventReferenceExpression^, CodeExpression^)

Initializes a new instance of the CodeAttachEventStatement class using the specified event and delegate.

System_CAPS_pubmethodCodeAttachEventStatement(CodeExpression^, String^, CodeExpression^)

Initializes a new instance of the CodeAttachEventStatement class using the specified object containing the event, event name, and event-handler delegate.


Gets a CodeDirectiveCollection object that contains end directives.(Inherited from CodeStatement.)


Gets or sets the event to attach an event-handler delegate to.


Gets or sets the line on which the code statement occurs. (Inherited from CodeStatement.)


Gets or sets the new event-handler delegate to attach to the event.


Gets a CodeDirectiveCollection object that contains start directives.(Inherited from CodeStatement.)


Gets the user-definable data for the current object.(Inherited from CodeObject.)


Determines whether the specified object is equal to the current object.(Inherited from Object.)


Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)


Serves as the default hash function. (Inherited from Object.)


Gets the Type of the current instance.(Inherited from Object.)


Creates a shallow copy of the current Object.(Inherited from Object.)


Returns a string that represents the current object.(Inherited from Object.)

CodeAttachEventStatement can be used to represent a statement that adds an event-handler delegate for an event. The Event property indicates the event to attach the event handler to. The Listener property indicates the event handler to attach.

The following example code demonstrates use of a CodeAttachEventStatement to attach an event handler with an event.

// Defines a delegate creation expression that creates an EventHandler delegate pointing to a method named TestMethod.
CodeDelegateCreateExpression^ createDelegate1 = gcnew CodeDelegateCreateExpression( gcnew CodeTypeReference( "System.EventHandler" ),gcnew CodeThisReferenceExpression,"TestMethod" );

// Attaches an EventHandler delegate pointing to TestMethod to the TestEvent event.
CodeAttachEventStatement^ attachStatement1 = gcnew CodeAttachEventStatement( gcnew CodeThisReferenceExpression,"TestEvent",createDelegate1 );

// A C# code generator produces the following source code for the preceeding example code:
//     this.TestEvent += new System.EventHandler(this.TestMethod);

.NET Framework
Available since 1.1

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

Return to top