MouseButtonEventArgs Class

MouseButtonEventArgs Class

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

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


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

public sealed class MouseButtonEventArgs : MouseEventArgs

The MouseButtonEventArgs type exposes the following members.

Public propertyHandledGets 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.
Public propertyOriginalSourceGets a reference to the object that raised the event. (Inherited from RoutedEventArgs.)
Public propertyStylusDeviceGets an object that reports stylus device information, such as the collection of stylus points associated with the input. (Inherited from MouseEventArgs.)

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetPositionReturns the x- and y-coordinates of the pointer position, optionally evaluated against a coordinate origin of a supplied UIElement. (Inherited from MouseEventArgs.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

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.

In Windows Phone, 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).

Mouse events are sometimes promoted events from touch input stimulus. For more information about the concept of mouse event promotion, see Quickstart: Touch input for Windows Phone 8.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

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

© 2017 Microsoft