Article
11/18/2011

MouseButtonEventArgs Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Provides event data for mouse button input events, for example UIElement.MouseLeftButtonDown and MouseRightButtonUp.

Inheritance Hierarchy

System.Object
  System.EventArgs
    System.Windows.RoutedEventArgs
      System.Windows.Input.MouseEventArgs
        System.Windows.Input.MouseButtonEventArgs

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

Syntax

'Declaration
Public NotInheritable Class MouseButtonEventArgs _
    Inherits MouseEventArgs

public sealed class MouseButtonEventArgs : MouseEventArgs

The MouseButtonEventArgs type exposes the following members.

Properties

	Name	Description
	ClickCount	Gets the number of times the button was clicked.
	Handled	Gets or sets a value that marks the routed event as handled. A true value for Handled prevents most handlers along the event route from handling the same event again.
	OriginalSource	Gets a reference to the object that raised the event. (Inherited from RoutedEventArgs.)
	StylusDevice	Gets an object that reports stylus device information, such as the collection of stylus points associated with the input. (Inherited from MouseEventArgs.)

Top

Methods

	Name	Description
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetPosition	Returns the x- and y-coordinates of the mouse pointer position, optionally evaluated against a coordinate origin of a supplied UIElement. (Inherited from MouseEventArgs.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

MouseButtonEventArgs defines Handled, which is relevant for marking a mouse button event as handled. Handling the event prevents typical handlers further along the route from acting on the same event occurrence. For details on how to mark mouse events as handled, see Mouse Support.

In Silverlight, MouseButtonEventArgs does not carry information that reports which mouse button was clicked (left button or right button). If you want to know whether the mouse button was the left mouse button or right mouse button, you must use separate handlers for each event (UIElement.MouseLeftButtonDown and UIElement.MouseRightButtonDown).

Mouse events are sometimes promoted events from touch input stimulus. For more information about the concept of mouse event promotion, see Touch Input in Silverlight.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Partager via