MouseButtonEventHandler Delegate (System.Windows.Input)

.NET Framework Class Library

MouseButtonEventHandler Delegate

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

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

Syntax

Visual Basic (Declaration)

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

Visual Basic (Usage)

Dim instance As New MouseButtonEventHandler(AddressOf HandlerMethod)

public delegate void MouseButtonEventHandler(
    Object sender,
    MouseButtonEventArgs e
)

Visual C++

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

JScript

JScript does not support delegates.

XAML

In XAML, you can use delegates but you cannot define your own.

Parameters

sender: Type: System..::.Object
The object where the event handler is attached.

e: Type: System.Windows.Input..::.MouseButtonEventArgs
The event data.

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.

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;
        }
    }
}

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

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

Version Information

.NET Framework

Supported in: 3.5, 3.0

Reference

System.Windows.Input Namespace

Other Resources

Input Overview

Routed Events Overview