MouseButton Enum

Definition

Namespace:

System.Windows.Input

Assembly:

PresentationCore.dll

Defines values that specify the buttons on a mouse device.

public enum class MouseButton

public enum MouseButton

type MouseButton = 

Public Enum MouseButton

Inheritance

Object

ValueType

Enum

MouseButton

Fields

Name	Value	Description
Left	0	The left mouse button.
Middle	1	The middle mouse button.
Right	2	The right mouse button.
XButton1	3	The first extended mouse button.
XButton2	4	The second extended mouse button.

Examples

The following example creates a MouseDown event handler that uses the MouseButton enumeration to determine which button was pressed. Depending on which button was pressed, the background of the control that fired the event is changed.

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

See also

• Mouse
• MouseEventArgs
• MouseButtonEventArgs
• MouseButtonState
• MouseAction