MouseButtonState Enum

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.

Specifies the possible states of a mouse button.

public enum class MouseButtonState

public enum MouseButtonState

type MouseButtonState =

Public Enum MouseButtonState

Inheritance: Object

ValueType

Enum
MouseButtonState

Fields

Name	Value	Description
Released	0	The button is released.
Pressed	1	The button is pressed.

Examples

The following example shows a mouse event handler that determines which buttons are currently pressed by checking the button state of each mouse button.

private void MouseDownHandler(object sender, MouseEventArgs e)
{
    if (e.RightButton == MouseButtonState.Pressed)
    {
        MessageBox.Show("The Right Mouse Button is pressed");
    }

    if (e.LeftButton == MouseButtonState.Pressed)
    {
        MessageBox.Show("The Left Mouse Button is pressed");
    }

    if (e.MiddleButton == MouseButtonState.Pressed)
    {

        MessageBox.Show("The Middle Mouse Button is pressed");
    }

    if (e.XButton1 == MouseButtonState.Pressed)
    {
        MessageBox.Show("The XButton1 Mouse Button is pressed");
    }

    if (e.XButton2 == MouseButtonState.Pressed)
    {
        MessageBox.Show("The XButton2 Mouse Button is pressed");
    }
}

Private Sub MouseDownHandler(ByVal sender As Object, ByVal e As MouseEventArgs)
    If e.RightButton = MouseButtonState.Pressed Then
        MessageBox.Show("The Right Mouse Button is pressed")
    End If

    If e.LeftButton = MouseButtonState.Pressed Then
        MessageBox.Show("The Left Mouse Button is pressed")
    End If

    If e.MiddleButton = MouseButtonState.Pressed Then

        MessageBox.Show("The Middle Mouse Button is pressed")
    End If

    If e.XButton1 = MouseButtonState.Pressed Then
        MessageBox.Show("The XButton1 Mouse Button is pressed")
    End If

    If e.XButton2 = MouseButtonState.Pressed Then
        MessageBox.Show("The XButton2 Mouse Button is pressed")
    End If
End Sub

Remarks

The MouseButtonState enumeration specifies constants which correlate to the state of a mouse button.

Applies to

Product	Versions
.NET Framework	3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop	3.0, 3.1, 5, 6, 7, 8, 9, 10

Share via