This documentation is archived and is not being maintained.

MouseButtonEventArgs.ButtonState Property

Gets the state of the button associated with the event.

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

public MouseButtonState ButtonState { get; }

Property Value

Type: System.Windows.Input.MouseButtonState
The state the button is in.

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

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.


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


.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: