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)
XML Namespace:

public MouseButtonState ButtonState { get; }
/** @property */
public MouseButtonState get_ButtonState ()

public function get ButtonState () : MouseButtonState

Members of this class are either not typically used in XAML, or cannot be used in XAML.

Property Value

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 raised the event. The color chosen depends on the mouse button which was pressed. The ChangedButton property is checked to determine which button was pressed.

private void MouseDownEventHandler(object sender, MouseButtonEventArgs e)
    if (e.ButtonState == MouseButtonState.Pressed)
        this.Background = Brushes.BurlyWood;

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0