MouseEvents.OnMouseDoubleClick Event

Parent Object: MouseEvents

Description

Event that occurs when the user presses and releases a mouse button and then presses and releases it again in quick succession.

Syntax

MouseEvents.OnMouseDoubleClick( Button As MouseButtonEnum, ShiftKeys As ShiftStateEnum, ModelPosition As Point, ViewPosition As Point2d, View As View )

Parameters

Name Type Description
Button MouseButtonEnum Returns an enumerated constant that identifies the button that was clicked to cause the event. The constants correspond to the left button (bit 0), right button (bit 1), and middle button (bit 2). These bits correspond to the values 1, 2, and 4, respectively. Only one of the bits is set, indicating the button that caused the event.
ShiftKeys ShiftStateEnum Returns an enumerated constant that corresponds to the state of the SHIFT, CTRL, and ALT keys when the button specified in the button argument is clicked. The constants correspond to one or more of those three keys being down. Each of these keys corresponds to a bit: SHIFT key (bit 0), the CTRL key (bit 1), and the ALT key (bit 2). These bits correspond to the values 1, 2, and 4, respectively. Combinations of these are provided as conveniences in the enumerator. For example, if only the ALT key was down, the constant kShiftStateAlt would be returned corresponding to the integer 4. If CTRL and ALT were pressed, the constant kShiftStateCtrlAlt would be returned whose integer value would be 6.
ModelPosition Point Returns the coordinates that specify the current location of the mouse pointer in model space and are returned in centimeters.
ViewPosition Point2d Returns the coordinates that specify the current location of the mouse pointer in window space and are returned in pixels.
View View Returns the View object where the mouse was pressed.

Version

Introduced in version 5