HandledMouseEventArgs Class
Allows a custom control to prevent the MouseWheel event from being sent to its parent container.
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)
The HandledMouseEventArgs type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | 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. |
![]() | 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. |
| Name | Description | |
|---|---|---|
![]() | 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.) |
| Name | Description | |
|---|---|---|
![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetHashCode | Serves as a hash function for a particular type. (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.) |
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.
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
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.
