ArcObjects Library Reference (PublisherControls)  

IARControlEvents.OnMouseDown Event

Fires when the user presses any mouse button while over the current map or page layout view.

[Visual Basic 6.0]
Event OnMouseDown(
    ByVal button As Long, _
    ByVal shift As Long, _
    ByVal x As Long, _
    ByVal y As Long _
) As Empty
[Visual Basic .NET]
Public Event OnMouseDown As OnMouseDownEventHandler
[C#]
public event OnMouseDownEventHandler OnMouseDown

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Description

The OnMouseDown event is triggered when the user presses a mouse button on the Map or PageLayout display area of the ArcReaderControl. Use the event to specify actions that will occur when a given mouse button is pressed.

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 CurrentView (the top left hand corner). x coordinates increase from left to right.

y is the Y coordinate, in pixels, where the mouse button was pressed referenced against the origin (0, 0) of the ArcReaderControl (the top left hand corner). y coordinates increase from top to bottom.

To find the origin of the CurrentView use ViewLeft and ViewTop properties. To convert x and y coorindates in pixels to map units and page units use the IARMap::ToMapPoint or IARPageLayout::ToPagePoint methods.

Remarks

Use the win32 SetCapture function to continue receiving mouse events (until the mouse is released) when the mouse is moved outside the control's display area. The win32 ReleaseCapture function releases the mouse.

[Visual Basic .NET]

 

See Also

IARControlEvents Interface