Table of contents
TOC
Collapse the table of content
Expand the table of content

MouseEvent.x Property (Visio)

office 365 dev account|Last Updated: 6/12/2017
|
1 Contributor

Returns the x-coordinate of the location in the Microsoft Visio window where a MouseDown , MouseMove , or MouseUp event fired. Read-only.

Syntax

expression . x

expression A variable that represents a MouseEvent object.

Return Value

VisStatCodes

Remarks

The x property returns a value in internal drawing units.

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 Microsoft Visual Basic for Applications (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) 

 Debug.Print "x is: "; x 
 Debug.Print "y is: "; y 

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 click anywhere in the active window to fire a MouseDown event. In the Immediate window, the handler prints the x and y coordinates of the location in the Visio window coordinate space where the mouse was clicked.

© 2017 Microsoft