MouseButtonEventHandler Delegate

Reference

Definition

Namespace:: System.Windows.Input

Assembly:: PresentationCore.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public delegate void MouseButtonEventHandler(System::Object ^ sender, MouseButtonEventArgs ^ e);

public delegate void MouseButtonEventHandler(object sender, MouseButtonEventArgs e);

type MouseButtonEventHandler = delegate of obj * MouseButtonEventArgs -> unit

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

Parameters

sender: Object

The object where the event handler is attached.

e: MouseButtonEventArgs

The event data.

Examples

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 void MouseButtonDownHandler(object sender, MouseButtonEventArgs e)
{
    Control src = e.Source as Control;

    if (src != null)
    {
        switch (e.ChangedButton)
        {
            case MouseButton.Left:
                src.Background = Brushes.Green;
                break;
            case MouseButton.Middle:
                src.Background = Brushes.Red;
                break;
            case MouseButton.Right:
                src.Background = Brushes.Yellow;
                break;
            case MouseButton.XButton1:
                src.Background = Brushes.Brown;
                break;
            case MouseButton.XButton2:
                src.Background = Brushes.Purple;
                break;
            default:
                break;
        }
    }
}

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

Remarks

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.

Extension Methods

GetMethodInfo(Delegate)

Gets an object that represents the method represented by the specified delegate.

Applies to

Share via