MouseEventArgs Class

Definition

Namespace:

System.Windows.Input

Assembly:

PresentationCore.dll

Provides data for mouse related routed events that do not specifically involve mouse buttons or the mouse wheel, for example MouseMove.

public ref class MouseEventArgs : System::Windows::Input::InputEventArgs

public class MouseEventArgs : System.Windows.Input.InputEventArgs

type MouseEventArgs = class
    inherit InputEventArgs

Public Class MouseEventArgs
Inherits InputEventArgs

Inheritance

Object

EventArgs

RoutedEventArgs

InputEventArgs

MouseEventArgs

Derived

System.Windows.Input.MouseButtonEventArgs

System.Windows.Input.MouseWheelEventArgs

System.Windows.Input.QueryCursorEventArgs

Remarks

This event data class is used with the following attached events.

• Mouse.GotMouseCapture

• Mouse.LostMouseCapture

• Mouse.MouseEnter

• Mouse.MouseLeave

• Mouse.MouseMove

• Mouse.PreviewMouseMove

This event data class is used with the following routed events. These routed events forward the previously listed attached events to make them more accessible to the general element model in WPF.

• UIElement.MouseEnter

• UIElement.MouseLeave

• UIElement.MouseMove

• UIElement.PreviewMouseMove

• ContentElement.MouseEnter

• ContentElement.MouseLeave

• ContentElement.MouseMove

• ContentElement.PreviewMouseMove

The attached events and the base element routed events share their event data, and the bubbling and tunneling versions of the routed events also share event data. This can affect the handled characteristics of the event as it travels the event route. For details, see Input Overview.

Other than the RoutedEventArgs properties that are relevant for all routed events, the most interesting properties of MouseEventArgs that you might use in a MouseEventHandler implementation are several properties that expose the current button state (such as LeftButton) and MouseDevice). MouseDevice is useful particularly because you can check Captured on it.

Note that events that specifically deal with mouse button events use a different event data class, MouseButtonEventArgs. The mouse button properties are available on MouseEventArgs in case there are input modes or interactions that involve the buttons even if you are handling a non-button event.

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

Constructors

MouseEventArgs(MouseDevice, Int32, StylusDevice)	Initializes a new instance of the MouseEventArgs class using the specified MouseDevice, timestamp, and StylusDevice.
MouseEventArgs(MouseDevice, Int32)	Initializes a new instance of the MouseEventArgs class using the specified MouseDevice and timestamp.

Properties

Device	Gets the input device that initiated this event. (Inherited from InputEventArgs)
Handled	Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route. (Inherited from RoutedEventArgs)
LeftButton	Gets the current state of the left mouse button.
MiddleButton	Gets the current state of the middle mouse button.
MouseDevice	Gets the mouse device associated with this event.
OriginalSource	Gets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class. (Inherited from RoutedEventArgs)
RightButton	Gets the current state of the right mouse button.
RoutedEvent	Gets or sets the RoutedEvent associated with this RoutedEventArgs instance. (Inherited from RoutedEventArgs)
Source	Gets or sets a reference to the object that raised the event. (Inherited from RoutedEventArgs)
StylusDevice	Gets the stylus device associated with this event.
Timestamp	Gets the time when this event occurred. (Inherited from InputEventArgs)
XButton1	Gets the current state of the first extended mouse button.
XButton2	Gets the state of the second extended mouse button.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetPosition(IInputElement)	Returns the position of the mouse pointer relative to the specified element.
GetType()	Gets the Type of the current instance. (Inherited from Object)
InvokeEventHandler(Delegate, Object)	Invokes event handlers in a type-specific way, which can increase event system efficiency.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnSetSource(Object)	When overridden in a derived class, provides a notification callback entry point whenever the value of the Source property of an instance changes. (Inherited from RoutedEventArgs)
ToString()	Returns a string that represents the current object. (Inherited from Object)

See also

• MouseEventHandler