HandledMouseEventArgs Class

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Source:: HandledMouseEventArgs.cs

Source:: HandledMouseEventArgs.cs

Source:: HandledMouseEventArgs.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Allows a custom control to prevent the MouseWheel event from being sent to its parent container.

public ref class HandledMouseEventArgs : System::Windows::Forms::MouseEventArgs

public class HandledMouseEventArgs : System.Windows.Forms.MouseEventArgs

type HandledMouseEventArgs = class
    inherit MouseEventArgs

Public Class HandledMouseEventArgs
Inherits MouseEventArgs

Inheritance: Object

EventArgs

MouseEventArgs
HandledMouseEventArgs

Derived: System.Windows.Forms.DataGridViewColumnDividerDoubleClickEventArgs

System.Windows.Forms.DataGridViewRowDividerDoubleClickEventArgs

Examples

The following code example demonstrates how to mark the mouse wheel event as handled in a custom control.

Public Class MouseWheelControl
    Sub New()
        ' Add initialization code for the control here. 
    End Sub

    Protected Sub MouseWheelControl_MouseWheel(ByVal sender As Object, ByVal e As MouseEventArgs) Handles Me.MouseWheel
        Dim Hme As HandledMouseEventArgs = e
        Hme.Handled = True
        ' Perform custom mouse wheel action here. 
    End Sub
End Class

Remarks

You will want to use HandledMouseEventArgs primarily when developing a control that needs to handle mouse wheel events itself, and prevent them from being seen by the control's immediate parent container. HandledMouseEventArgs is not passed directly by MouseEventHandler when it handles the MouseWheel event. Rather, MouseEventHandler uses a MouseEventArgs, which you must cast to a HandledMouseEventArgs in order to cancel an occurrence of MouseWheel.

Constructors

HandledMouseEventArgs(MouseButtons, Int32, Int32, Int32, Int32, Boolean)	Initializes a new instance of the HandledMouseEventArgs class with the specified mouse button, number of mouse button clicks, horizontal and vertical screen coordinates, the change of mouse pointer position, and the value indicating whether the event is handled.
HandledMouseEventArgs(MouseButtons, Int32, Int32, Int32, Int32)	Initializes a new instance of the HandledMouseEventArgs class with the specified mouse button, number of mouse button clicks, horizontal and vertical screen coordinates, and the change of mouse pointer position.

Properties

Button	Gets which mouse button was pressed. (Inherited from MouseEventArgs)
Clicks	Gets the number of times the mouse button was pressed and released. (Inherited from MouseEventArgs)
Delta	Gets a signed count of the number of detents the mouse wheel has rotated, multiplied by the WHEEL_DELTA constant. A detent is one notch of the mouse wheel. (Inherited from MouseEventArgs)
Handled	Gets or sets whether this event should be forwarded to the control's parent container.
Location	Gets the location of the mouse during the generating mouse event. (Inherited from MouseEventArgs)
X	Gets the x-coordinate of the mouse during the generating mouse event. (Inherited from MouseEventArgs)
Y	Gets the y-coordinate of the mouse during the generating mouse event. (Inherited from MouseEventArgs)

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)

Applies to

Jaa