ESRI.ArcGIS.ADF
OnMouseDown Method
See Also  Send comments on this topic.
ESRI.ArcGIS.ADF.BaseClasses Namespace > BaseTool Class : OnMouseDown Method




Button
Specifies which mouse button is 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, Shift would be 5.
X
The X coordinate, in device units, of the location of the mouse event. See the OnMouseDown Event for more details.
Y
The Y coordinate, in device units, of the location of the mouse event. See the OnMouseDown Event for more details.
This method is called when a mouse button is pressed down, when this tool is active.

Syntax

Visual Basic (Declaration) 
Public Overridable Sub OnMouseDown( _
   ByVal Button As Integer, _
   ByVal Shift As Integer, _
   ByVal X As Integer, _
   ByVal Y As Integer _
) 
Visual Basic (Usage)Copy Code
Dim instance As BaseTool
Dim Button As Integer
Dim Shift As Integer
Dim X As Integer
Dim Y As Integer
 
instance.OnMouseDown(Button, Shift, X, Y)
C# 
public virtual void OnMouseDown( 
   int Button,
   int Shift,
   int X,
   int Y
)

Parameters

Button
Specifies which mouse button is 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, Shift would be 5.
X
The X coordinate, in device units, of the location of the mouse event. See the OnMouseDown Event for more details.
Y
The Y coordinate, in device units, of the location of the mouse event. See the OnMouseDown Event for more details.

Remarks

Note to inheritors: Override the OnMouseDown method if you need to perform some action when the OnMouseDown is raised when the tool is active.

See Also

© 2010 All Rights Reserved.