Share via


MouseEventArgs Class

Definition

Supplies information about a mouse event that is being raised.

public ref class MouseEventArgs : EventArgs
public class MouseEventArgs : EventArgs
type MouseEventArgs = class
    inherit EventArgs
Public Class MouseEventArgs
Inherits EventArgs
Inheritance
MouseEventArgs
Derived

Constructors

MouseEventArgs()

Properties

AltKey

true if the alt key was down when the event was fired. false otherwise.

Button

The button number that was pressed when the mouse event was fired: Left button=0, middle button=1 (if present), right button=2. For mice configured for left handed use in which the button actions are reversed the values are instead read from right to left.

Buttons

The buttons being pressed when the mouse event was fired: Left button=1, Right button=2, Middle (wheel) button=4, 4th button (typically, "Browser Back" button)=8, 5th button (typically, "Browser Forward" button)=16. If two or more buttons are pressed, returns the logical sum of the values. E.g., if Left button and Right button are pressed, returns 3 (=1 | 2).

ClientX

The X coordinate of the mouse pointer in local (DOM content) coordinates.

ClientY

The Y coordinate of the mouse pointer in local (DOM content) coordinates.

CtrlKey

true if the control key was down when the event was fired. false otherwise.

Detail

A count of consecutive clicks that happened in a short amount of time, incremented by one.

MetaKey

true if the meta key was down when the event was fired. false otherwise.

MovementX

The X coordinate of the mouse pointer relative to the position of the last mousemove event.

MovementY

The Y coordinate of the mouse pointer relative to the position of the last mousemove event.

OffsetX

The X coordinate of the mouse pointer in relative (Target Element) coordinates.

OffsetY

The Y coordinate of the mouse pointer in relative (Target Element) coordinates.

PageX

The X coordinate of the mouse pointer relative to the whole document.

PageY

The Y coordinate of the mouse pointer relative to the whole document.

ScreenX

The X coordinate of the mouse pointer in global (screen) coordinates.

ScreenY

The Y coordinate of the mouse pointer in global (screen) coordinates.

ShiftKey

true if the shift key was down when the event was fired. false otherwise.

Type

Gets or sets the type of the event.

Applies to