| General Properties Methods Events Example |
Note: Standard control events such as DragOver, GotFocus, Validate, etc., are not listed here. See the Visual Basic documentation for help on standard control events.
All of the events below return X as Single and Y as Single, representing the current location of the mouse cursor when the event was raised.
| Click |
Click (HotspotID as String, X As Single, Y As Single)
Occurs when the user presses and releases the mouse button (left or right) anywhere on the ImageMap control.
HotspotID will be the ID of the Hotspot that was clicked on, or an empty String if a Hotspot was not clicked. See the HotspotClick event for a more detailed explanation of the HotspotID return value.
DblClick (HotspotID as String, X As Single, Y As Single)
Occurs when the user presses and releases a mouse button and then presses and releases it again over the ImageMap control.
If the second click does not occur within the system's double-click time limit, another Click event will be raised. The double-click time limit may vary because the user can set the double-click speed in the Control Panel.
HotspotID will be the ID of the Hotspot that was double-clicked on, or an empty String if a Hotspot was not double-clicked. See the HotspotClick event for a more detailed explanation of the HotspotID return value.
HotspotClick (HotspotID As String, X As Single, Y As Single)
Occurs when the user presses and releases the mouse button (left or right) over a hotspot.
HotspotID is the ID of the area specified by the "id" attribute within the <area> tag that defines this particular hotspot in the HTML <map>. See the CoordsFile property for details on the syntax of HTML image maps and usage of the "id" attribute. If no "id" attribute was found in the <area> tag, the value for "alt", "title", "class", or "name" will be used to determine the hotspot id. If none of those attributes are present, the hotspot will be given the id of "Hotspot #", where # is the nth <area> tag found in the map. For example, if the current hotspot was defined in the 3rd <area> tag, it will have a HotspotID of "Hotspot 3". The attribute "id" will always be used if found, regardless if the other tags are present or not.
HotspotDblClick (HotspotID As String, X As Single, Y As Single)
Occurs when the user double-clicks the mouse over a hotspot.
If the second click does not occur within the system's double-click time limit, another HotspotClick event will be raised. The double-click time limit may vary because the user can set the double-click speed in the Control Panel. See the HotspotClick event for an explanation of the HotspotID return value.
HotspotMouseDown (HotspotID As String, Button As Integer, Shift As Integer, X As Single, Y As Single)
Occurs when the user presses a mouse button over a hotspot
See the HotspotClick event for an explanation of the HotspotID return value.
The following also applies to the MouseDown event:
Button returns an integer that identifies the button that was pressed to cause the event. The possible return values are 1 (left button), 2 (right button), and 4 (middle button).
Shift returns an integer that corresponds to the state of the SHIFT, CTRL, and ALT keys at the time the button specified in the Button argument was pressed. A bit is set if the key is down. The shift argument is a bit field with the least-significant bits corresponding to the 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. Some, all, or none of the bits can be set, indicating that some, all, or none of the keys are pressed. For example, if both CTRL and ALT were pressed, the value of Shift would be 6.
HotspotMouseMove (HotspotID As String, Button As Integer, Shift As Integer, X As Single, Y As Single)
Occurs when the user moves the mouse over a hotspot.
The HotspotMouseMove event is generated continually as the mouse pointer moves across a hotspot.
See the HotspotClick event for an explanation of the HotspotID return value.
The following also applies to the MouseMove event:
Button returns an integer that corresponds to the state of the mouse buttons in which a bit is set if the button is down. The button argument is a bit field with bits corresponding 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. It indicates the complete state of the mouse buttons; some, all, or none of these three bits can be set, indicating that some, all, or none of the buttons are pressed.
The Button argument for MouseMove differs from the Button argument for MouseDown and MouseUp. For MouseMove, the button argument indicates the current state of all buttons; a single MouseMove event can indicate that some, all, or no buttons are pressed. For MouseDown and MouseUp, the button argument indicates exactly one button per event.
HotspotMouseUp (HotspotID As String, Button As Integer, Shift As Integer, X As Single, Y As Single)
Occurs when the user releases a mouse button over a hotspot.
See the HotspotClick event for an explanation of the HotspotID return value.
See the HotspotMouseDown event for an explanation of the Button and Shift return values.
MouseDown (HotspotID as String, Button As Integer, Shift As Integer, X As Single, Y As Single)
Occurs when the user presses a mouse button anywhere over the ImageMap control.
HotspotID will be the ID of the Hotspot the mouse was over when the button was pressed, or an empty String if the mouse was not over a Hotspot. See the HotspotClick event for a more detailed explanation of the HotspotID return value.
See the HotspotMouseDown event for an explanation of the Button and Shift return values.
MouseMove (HotspotID as String, Button As Integer, Shift As Integer, X As Single, Y As Single)
Occurs when the user moves the mouse anywhere over the ImageMap control.
The MouseMove event is generated continually as the mouse pointer moves across the ImageMap control.
HotspotID will be the ID of the Hotspot the mouse was moved over, or an empty String if the mouse was not over a Hotspot. See the HotspotClick event for a more detailed explanation of the HotspotID return value.
See the HotspotMouseMove event for an explanation of the Button and Shift return values.
MouseUp (HotspotID as String, Button As Integer, Shift As Integer, X As Single, Y As Single)
Occurs when the user releases a mouse button anywhere over the ImageMap control.
HotspotID will be the ID of the Hotspot the mouse was over when the button was released, or an empty String if the mouse was not over a Hotspot. See the HotspotClick event for a more detailed explanation of the HotspotID return value.
See the HotspotMouseDown event for an explanation of the Button and Shift return values.