Type: System.CodeDom.CodeAttachEventStatement

System.CodeDom.CodeAttachEventStatement Class

Assembly: System.dll
Namespace: System.CodeDom

Summary: Represents a statement that attaches an event handler.

C# Syntax:

[Serializable]
public class CodeAttachEventStatement : CodeStatement

Remarks

CodeAttachEventStatement can be used to represent a statement that adds a listener or handler for an event or delegate.

Example

The following code creates a CodeAttachEventStatement named attachevent1 that attaches an event handler method named UpdateDisplay to an event named OnPaint:

          CodeAttachEventStatement attachevent1 = new CodeAttachEvent(this, OnPaint, UpdateDisplay);

See also:

System.CodeDom Namespace

System.CodeDom.CodeAttachEventStatement Member List:

Public Constructors

ctor #1	Overloaded: `.ctor()`Default constructor. This constructor is called by derived class constructors to initialize state in this type. Initializes a new instance of the CodeAttachEventStatement class.
ctor #2	Overloaded: `.ctor(CodeEventReferenceExpression eventRef, CodeExpression listener)` Initializes a new instance of the CodeAttachEventStatement class using the specified event reference and listener.
ctor #3	Overloaded: `.ctor(CodeExpression targetObject, string eventName, CodeExpression listener)` Initializes a new instance of the CodeAttachEventStatement class using the specified object containing the event, event name, and listener.

Public Properties

Event	Read-write Gets or sets the event to attach a listener to.
LinePragma (inherited from System.CodeDom.CodeStatement)	Read-write See base class member description: System.CodeDom.CodeStatement.LinePragma Gets or sets the line the statement occurs on.
Listener	Read-write Gets or sets the new listener to attach to the event.
UserData (inherited from System.CodeDom.CodeObject)	Read-only See base class member description: System.CodeDom.CodeObject.UserData Gets or sets the user-definable data for the current object.

Public Methods

Equals (inherited from System.Object)	See base class member description: System.Object.Equals Derived from System.Object, the primary base class for all objects.
GetHashCode (inherited from System.Object)	See base class member description: System.Object.GetHashCode Derived from System.Object, the primary base class for all objects.
GetType (inherited from System.Object)	See base class member description: System.Object.GetType Derived from System.Object, the primary base class for all objects.
ToString (inherited from System.Object)	See base class member description: System.Object.ToString Derived from System.Object, the primary base class for all objects.

Protected Methods

Finalize (inherited from System.Object)	See base class member description: System.Object.Finalize Derived from System.Object, the primary base class for all objects.
MemberwiseClone (inherited from System.Object)	See base class member description: System.Object.MemberwiseClone Derived from System.Object, the primary base class for all objects.

Hierarchy:

System.Object

System.CodeDom.CodeObject

System.CodeDom.CodeStatement

System.CodeDom.CodeAttachEventStatement

System.CodeDom.CodeAttachEventStatement Member Details

Overloaded ctor #1

Summary: Initializes a new instance of the CodeAttachEventStatement class.

Default constructor. This constructor is called by derived class constructors to initialize state in this type.

C# Syntax:


            public CodeAttachEventStatement();

Return to top

Overloaded ctor #2

Summary: Initializes a new instance of the CodeAttachEventStatement class using the specified event reference and listener.

C# Syntax:


            public CodeAttachEventStatement(
   CodeEventReferenceExpression eventRef,
   CodeExpression listener
);

Parameters:

eventRef

A CodeEventReferenceExpression that indicates the event to attach a handler to.

listener

A CodeExpression that indicates the new listener.

See also:
CodeExpression

Return to top

Overloaded ctor #3

Summary: Initializes a new instance of the CodeAttachEventStatement class using the specified object containing the event, event name, and listener.

C# Syntax:


            public CodeAttachEventStatement(
   CodeExpression targetObject,
   string eventName,
   CodeExpression listener
);

Parameters:

targetObject

A CodeExpression that indicates the object that contains the event.

eventName

The name of the event to attach a handler to.

listener

A CodeExpression that indicates the new listener.

Return to top

Property: Event (read-write)

Summary: Gets or sets the event to attach a listener to.

C# Syntax:


            public CodeEventReferenceExpression Event {get; set;}

Return to top

Property: LinePragma (read-write)

Inherited
See base class member description: System.CodeDom.CodeStatement.LinePragma

Summary: Gets or sets the line the statement occurs on.

C# Syntax:


            public CodeLinePragma LinePragma {get; set;}

Remarks

This property indicates the location of the statement.

See also:
CodeLinePragma

Return to top

Property: Listener (read-write)

Summary: Gets or sets the new listener to attach to the event.

C# Syntax:


            public CodeExpression Listener {get; set;}

Return to top

Property: UserData (read-only)

Inherited
See base class member description: System.CodeDom.CodeObject.UserData

Summary: Gets or sets the user-definable data for the current object.

C# Syntax:


            public IDictionary UserData {get;}

Remarks

Notes to inheritors: An inheritor can design the way this user data is stored, retrieved, and used.

Return to top

Method: Equals(
object obj
)

Inherited
See base class member description: System.Object.Equals

C# Syntax:


            public virtual bool Equals(
   object obj
);