HandledMouseEventArgs.Handled Property

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

HandledMouseEventArgs.cs

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

public:
 property bool Handled { bool get(); void set(bool value); };

public bool Handled { get; set; }

member this.Handled : bool with get, set

Public Property Handled As Boolean

Property Value

Boolean

true if the mouse event should go to the parent control; otherwise, false.

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