MouseButtonEventArgs.ButtonState Property

Definition

Gets the state of the button associated with the event.

C#
public System.Windows.Input.MouseButtonState ButtonState { get; }

Property Value

The state the button is in.

Examples

The following example creates a mouse button event handler that changes the color of the object that handles the event. The color that is chosen depends on whether the mouse button was pressed or released.

C#
private void MouseButtonEventHandler(object sender, MouseButtonEventArgs e)
{
    if (e.ButtonState == MouseButtonState.Pressed)
    {
        this.Background = Brushes.BurlyWood;
    }

    if (e.ButtonState == MouseButtonState.Released)
    {
        this.Background = Brushes.Ivory;
    }
}

Remarks

The Mouse class provides additional properties and methods for determining the state of the mouse.

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

See also