MouseMove Event [Visio 2003 SDK Documentation]

Occurs when the mouse is moved.

Private Sub    object_MouseMove ( ByVal Button As Long, ByVal KeyButtonState As Long, ByVal x As Double, ByVal y As Double, CancelDefault As Boolean)

object     The WithEvents object from the Applies to list that receives the event.

Button     The mouse button that was clicked. See Remarks for possible values.

KeyButtonState    The state of the mouse buttons and the SHIFT and CTRL keys for the event. See Remarks for possible values.

x     The x-coordinate of the mouse pointer.

x     The y-coordinate of the mouse pointer.

CancelDefault     False if Microsoft Office Visio should process the message it receives from this event; otherwise, True.

Version added

2003

Remarks

Possible values for Button are shown in the following table, and are declared in VisKeyButtonFlags in the Visio type library.

Constant	Value
visMouseLeft	1
visMouseMiddle	16
visMouseRight	2

Possible values for KeyButtonState can be a combination of the values shown in the following table, which are declared in VisKeyButtonFlags in the Visio type library. For example, if KeyButtonState returns 9, it indicates that the user clicked the left mouse button while pressing CTRL.

Constant	Value
visKeyControl	8
visKeyShift	4
visMouseLeft	1
visMouseMiddle	16
visMouseRight	2

If you set CancelDefault to True, Visio will not process the message received when the mouse button is clicked.

Unlike some other Visio events, MouseMove does not have the prefix "Query," but it is nevertheless a query event. That is, you can cancel processing the message sent by MouseMove, either by setting CancelDefault to True, or, if you are using theVisEventProc method to handle the event, by returning True. For more information, see the topics for the VisEventProc method and for any of the query events (for example, the QueryCancelSuspend event) in this Automation Reference.

If you are using Microsoft Visual Basic or Visual Basic for Applications (VBA), the syntax in this topic describes a common, efficient way to handle events.

If you want to create your own Event objects, use the Add or AddAdvise method. To create an Event object that runs an add-on, use the Add method as it applies to the EventList collection. To create an Event object that receives notification, use the AddAdvise method. To find an event code for the event you want to create, see Event codes.

Example

This class module shows how to define a sink class called MouseListener that listens for events fired by mouse actions in the active window. It declares the object variable vsoWindow by using the WithEvents keyword. The class module also contains event handlers for the MouseDown, MouseMove, and MouseUp events.

To run this example, insert a new class module in your VBA project, name it MouseListener, and insert the following code in the module.

Dim WithEvents vsoWindow As Visio.Window

Private Sub Class_Initialize()

    Set vsoWindow = ActiveWindow
    
End Sub

Private Sub Class_Terminate()

    Set vsoWindow = Nothing

End Sub

Private Sub vsoWindow_MouseDown(ByVal Button As Long, ByVal KeyButtonState As Long, ByVal x As Double, ByVal y As Double, CancelDefault As Boolean)
    
    If Button = 1 Then
    
        Debug.Print "Left mouse button clicked"
    
    ElseIf Button = 2 Then
    
        Debug.Print "Right mouse button clicked"
        
    ElseIf Button = 16 Then
    
        Debug.Print "Center mouse button clicked"
        
    End If
        
End Sub

Private Sub vsoWindow_MouseMove(ByVal Button As Long, ByVal KeyButtonState As Long, ByVal x As Double, ByVal y As Double, CancelDefault As Boolean)
    
    Debug.Print "x-position is "; x
    Debug.Print "y-position is "; y
            
End Sub

Private Sub vsoWindow_MouseUp(ByVal Button As Long, ByVal KeyButtonState As Long, ByVal x As Double, ByVal y As Double, CancelDefault As Boolean)
    
    If Button = 1 Then
    
        Debug.Print "Left mouse button released"
    
    ElseIf Button = 2 Then
    
        Debug.Print "Right mouse button released"
        
    ElseIf Button = 16 Then
    
        Debug.Print "Center mouse button released"
        
    End If
        
End Sub
                

Then, insert the following code in the ThisDocument project.

Dim myMouseListener As MouseListener

Private Sub Document_DocumentSaved(ByVal doc As IVDocument)

    Set myMouseListener = New MouseListener

End Sub

Private Sub Document_BeforeDocumentClose(ByVal doc As IVDocument)

    Set myMouseListener = Nothing
    
End Sub

Save the document to initialize the class, and then move the mouse briefly in the active window to fire a series of MouseMove events. In the Immediate window, the handler prints a list of x- and y-position value pairs, each of which corresponds to the mouse position when a MouseMove event fired.

Applies to | Application object | Document object | Documents collection | InvisibleApp object

See Also | Action property | AddAdvise method | BeforeDocumentSaveAs event | DocumentSaved event | DocumentSavedAs event | Event object | EventList collection