This document is archived and information here might be outdated.  Recommended version.


IPageLayoutControlEvents.OnMouseMove Event (ArcObjects .NET 10.8 SDK)
ArcObjects Help for .NET developers > ArcObjects Help for .NET developers > ArcObjects namespaces > Controls > ESRI ArcGIS Controls > Interfaces > IP > IPageLayoutControlEvents Interface > IPageLayoutControlEvents.OnMouseMove Event
ArcGIS Developer Help

IPageLayoutControlEvents.OnMouseMove Event

Fires when the user moves the mouse pointer over the PageLayoutControl.

[Visual Basic .NET]
Public Event OnMouseMove As OnMouseMoveEventHandler
[C#]
public event OnMouseMoveEventHandler OnMouseMove
[C++]
HRESULT OnMouseMove(
  long button,
  long shift,
  long X,
  long Y,
  double pageX,
  double pageY
);
[C++]
Parameters
button [in]

button is a parameter of type long shift [in]
shift is a parameter of type long X [in]
X is a parameter of type long Y [in]
Y is a parameter of type long pageX [in]
pageX is a parameter of type double pageY [in]
pageY is a parameter of type double

Product Availability

Available with ArcGIS Engine.

Description

The OnMouseMove event is triggered continually as the mouse moves over the PageLayoutControl.

button specifies which mouse button was pressed. 1 for the left mouse button, 2 for the right mouse button, and 4 for the middle mouse button.

shift specifies an integer corresponding to the state of the SHIFT (bit 0), CTRL (bit 1) and ALT (bit 2) keys. When none, some or all of these keys are pressed none, some or all the bits get set. These bits correspond to the values 1, 2, and 4, respectively. For example, if both SHIFT and ALT were pressed, ShiftState would return 5.

x is the X coordinate, in pixels, where the mouse button was pressed referenced against the origin (0, 0) of the PageLayoutControl (the top left hand corner).

y is the Y coordinate, in pixels, where the mouse button was pressed referenced against the origin (0, 0) of the PageLayoutControl (the top left hand corner).

pageX is the X coordinate, in page units, where the mouse button was pressed referenced against the origin (bottom left hand corner) of the IPageLayoutControl::Page. The values returned are in IPage::Units.

pageY is the Y coordinate, in page units, where the mouse button was pressed referenced against the origin (bottom left hand corner) of the IPageLayoutControl::Page. The values returned are in IPage::Units.

See Also

IPageLayoutControlEvents Interface