CodeRemoveEventStatement Class

Definition

Namespace:

System.CodeDom

Assembly:

System.CodeDom.dll

Represents a statement that removes an event handler.

public ref class CodeRemoveEventStatement : System::CodeDom::CodeStatement

public class CodeRemoveEventStatement : System.CodeDom.CodeStatement

type CodeRemoveEventStatement = class
    inherit CodeStatement

Public Class CodeRemoveEventStatement
Inherits CodeStatement

Inheritance

Object

CodeObject

CodeStatement

CodeRemoveEventStatement

Examples

The following example demonstrates use of a CodeRemoveEventStatement to remove a delegate from an event.

// Creates a delegate of type System.EventHandler pointing to a method named OnMouseEnter.
CodeDelegateCreateExpression^ mouseEnterDelegate = gcnew CodeDelegateCreateExpression( gcnew CodeTypeReference( "System.EventHandler" ),gcnew CodeThisReferenceExpression,"OnMouseEnter" );

// Creates a remove event statement that removes the delegate from the TestEvent event.
CodeRemoveEventStatement^ removeEvent1 = gcnew CodeRemoveEventStatement( gcnew CodeThisReferenceExpression,"TestEvent",mouseEnterDelegate );

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

// Creates a delegate of type System.EventHandler pointing to a method named OnMouseEnter.
CodeDelegateCreateExpression mouseEnterDelegate = new CodeDelegateCreateExpression( new CodeTypeReference("System.EventHandler"), new CodeThisReferenceExpression(), "OnMouseEnter" );
// Creates a remove event statement that removes the delegate from the TestEvent event.
CodeRemoveEventStatement removeEvent1 = new CodeRemoveEventStatement( new CodeThisReferenceExpression(), "TestEvent", mouseEnterDelegate );

// A C# code generator produces the following source code for the preceeding example code:

//     this.TestEvent -= new System.EventHandler(this.OnMouseEnter);

' Creates a delegate of type System.EventHandler pointing to a method named OnMouseEnter.
Dim mouseEnterDelegate As New CodeDelegateCreateExpression(New CodeTypeReference("System.EventHandler"), New CodeThisReferenceExpression(), "OnMouseEnter")
' Creates a remove event statement that removes the delegate from the TestEvent event.
Dim removeEvent1 As New CodeRemoveEventStatement(New CodeThisReferenceExpression(), "TestEvent", mouseEnterDelegate)

' A Visual Basic code generator produces the following source code for the preceeding example code:

'   RemoveHandler TestEvent, AddressOf Me.OnMouseEnter

Remarks

CodeRemoveEventStatement can be used to represent a statement that removes an event handler for an event.

The Event property specifies the event to remove the event handler from. The Listener property specifies the event handler to remove.

Constructors

CodeRemoveEventStatement()	Initializes a new instance of the CodeRemoveEventStatement class.
CodeRemoveEventStatement(CodeEventReferenceExpression, CodeExpression)	Initializes a new instance of the CodeRemoveEventStatement class with the specified event and event handler.
CodeRemoveEventStatement(CodeExpression, String, CodeExpression)	Initializes a new instance of the CodeRemoveEventStatement class using the specified target object, event name, and event handler.

Properties

EndDirectives	Gets a CodeDirectiveCollection object that contains end directives. (Inherited from CodeStatement)
Event	Gets or sets the event to remove a listener from.
LinePragma	Gets or sets the line on which the code statement occurs. (Inherited from CodeStatement)
Listener	Gets or sets the event handler to remove.
StartDirectives	Gets a CodeDirectiveCollection object that contains start directives. (Inherited from CodeStatement)
UserData	Gets the user-definable data for the current object. (Inherited from CodeObject)

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)