HandledMouseEventArgs Class
TOC
Collapse the table of content
Expand the table of content

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 class HandledMouseEventArgs : MouseEventArgs

NameDescription
System_CAPS_pubmethodHandledMouseEventArgs(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.

System_CAPS_pubmethodHandledMouseEventArgs(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.

NameDescription
System_CAPS_pubpropertyButton

Gets which mouse button was pressed.(Inherited from MouseEventArgs.)

System_CAPS_pubpropertyClicks

Gets the number of times the mouse button was pressed and released.(Inherited from MouseEventArgs.)

System_CAPS_pubpropertyDelta

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.)

System_CAPS_pubpropertyHandled

Gets or sets whether this event should be forwarded to the control's parent container.

System_CAPS_pubpropertyLocation

Gets the location of the mouse during the generating mouse event.(Inherited from MouseEventArgs.)

System_CAPS_pubpropertyX

Gets the x-coordinate of the mouse during the generating mouse event.(Inherited from MouseEventArgs.)

System_CAPS_pubpropertyY

Gets the y-coordinate of the mouse during the generating mouse event.(Inherited from MouseEventArgs.)

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

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

.NET Framework
Available since 2.0

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

Return to top
Show:
© 2016 Microsoft