MouseButtonEventHandler Delegate

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Represents the method that will handle mouse button related routed events, for example UIElement.MouseLeftButtonDown.

Namespace:   System.Windows.Input
Assembly:  PresentationCore (in PresentationCore.dll)

Public Delegate Sub MouseButtonEventHandler (
	sender As Object,
	e As MouseButtonEventArgs
)

Parameters

sender
Type: System.Object

The object where the event handler is attached.

e
Type: System.Windows.Input.MouseButtonEventArgs

The event data.

This delegate is used with the following attached events.

This delegate is used with the following routed events. These routed events forward the previously listed attached events to make them more accessible to the general element model in WPF.

The attached events and the base element routed events share their event data, and the bubbling and tunneling versions of the routed events also share event data. This can affect the handled characteristics of the event as it travels the event route. For details, see Input Overview.

The following example creates a MouseDown event handler that changes the background color of the source of the event. The background color is determined by which button is pressed.

Private Sub MouseButtonDownHandler(ByVal sender As Object, ByVal e As MouseButtonEventArgs)
    Dim src As Control = TryCast(e.Source, Control)

    If src IsNot Nothing Then
        Select Case e.ChangedButton
            Case MouseButton.Left
                src.Background = Brushes.Green
            Case MouseButton.Middle
                src.Background = Brushes.Red
            Case MouseButton.Right
                src.Background = Brushes.Yellow
            Case MouseButton.XButton1
                src.Background = Brushes.Brown
            Case MouseButton.XButton2
                src.Background = Brushes.Purple
            Case Else
        End Select
    End If
End Sub

.NET Framework
Available since 3.0
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Return to top
Show: