Export (0) Print
Expand All

HandledMouseEventArgs Class

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

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public ref class HandledMouseEventArgs : public MouseEventArgs

The HandledMouseEventArgs type exposes the following members.

  NameDescription
Public methodHandledMouseEventArgs(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.
Public methodHandledMouseEventArgs(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.
Top

  NameDescription
Public propertyButtonGets which mouse button was pressed. (Inherited from MouseEventArgs.)
Public propertyClicksGets the number of times the mouse button was pressed and released. (Inherited from MouseEventArgs.)
Public propertyDeltaGets 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.)
Public propertyHandledGets or sets whether this event should be forwarded to the control's parent container.
Public propertyLocationGets the location of the mouse during the generating mouse event. (Inherited from MouseEventArgs.)
Public propertyXGets the x-coordinate of the mouse during the generating mouse event. (Inherited from MouseEventArgs.)
Public propertyYGets the y-coordinate of the mouse during the generating mouse event. (Inherited from MouseEventArgs.)
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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