Using the CALLTHIS function in Visio

Visio was the first non-Microsoft application to include VBA within it back in the mid-nineties. All of the desktop Microsoft Office applications currently include VBA, although Microsoft have been rumoured to want to replace it for many years, and now there is an alternative scripting option becoming available that is suitable for the web too.

Visio was acquired by Microsoft in 2000, and there are still many scenarios when it is useful to have VBA procedures available in Visio for the Desktop. These procedures can be created using the recorder, and then edited, or just created manually. Every Visio document can contain a VBA project, but it must be saved with the .vsdm extension for documents, .vssm extension for stencils, or .vstm extension for templates. The last letter, m, informs Windows that this file could contain macros, as opposed to the normal last letter x, which cannot. Even with this extension, users, or their IT department, may not enable the macros in Visio documents.

The CALLTHIS function in Visio can be used to run a procedure (sub-function) in a Visio Visual Basic document and pass through a reference to the shape that the function is called from. The Microsoft Docs provide an explanation of this useful technique, and it does describe some examples, but it does not show the VBA code that these examples need, nor does it show them working. It also does not make it clear that these procedures do not need to be in the Visio diagram document, but can be in a stencil that is open in the active Visio session. This is important because it means that VBA code can be centralised and distributed for use use on many other documents.

The shapes on the Visio document call code in the diagram document itself (CallThisExamples.vsdm), or in the stencil (CallThisExamples.vssm). They should be downloaded an placed into the same folder in OneDriveforBusiness. Opening the diagram document in Visio for the Desktop should then open the stencil in the workplace too.

VBA Code

The VBA code is duplicated in the document and in the stencil in order to demonstrate the how the procedures could be called from each.

ThisDocument is actually a Class, not a Module, and so needs to be included in the argument that is passed to the CALLTHIS function.

In Document

ThisDocument

Option Explicit

Public Sub A(vsoShape As Visio.Shape)
    MsgBox vsoShape.Name, _
        vbInformation, "ThisDocument.A"
End Sub

Public Sub B(vsoShape As Visio.Shape, arg1 As String)
    MsgBox vsoShape.Name & " with arg1=" & arg1, _
        vbInformation, "ThisDocument.B"
End Sub

Public Sub C(vsoShape As Visio.Shape, arg1 As String, arg2 As String)
    MsgBox vsoShape.Name & " with arg1=" & arg1 & ", arg2=" & arg2, _
        vbInformation, "ThisDocument.C"
End Sub

ModuleInDocument

Option Explicit

Public Sub p(vsoShape As Visio.Shape, heightInCm As String)
    MsgBox vsoShape.Name & " is " & heightInCm & " high", _
        vbInformation, "ModuleInDocument.p"
End Sub

Public Sub q(vsoShape As Visio.Shape, heightInCm As Double, widthInIU As Double)
    MsgBox vsoShape.Name & " is " & CStr(heightInCm) & " high by " & CStr(widthInIU) & " wide", _
        vbInformation, "ModuleInDocument.q"
End Sub

In Stencil

ThisDocument

Option Explicit

Public Sub A(vsoShape As Visio.Shape)
    MsgBox vsoShape.Name, _
        vbInformation, "CallThisExamples.ThisDocument.A"
End Sub

Public Sub B(vsoShape As Visio.Shape, arg1 As String)
    MsgBox vsoShape.Name & " with arg1=" & arg1, _
        vbInformation, "CallThisExamples.ThisDocument.B"
End Sub

Public Sub C(vsoShape As Visio.Shape, arg1 As String, arg2 As String)
    MsgBox vsoShape.Name & " with arg1=" & arg1 & ", arg2=" & arg2, _
        vbInformation, "CallThisExamples.ThisDocument.C"
End Sub

ModuleInStencil

Option Explicit

Public Sub p(vsoShape As Visio.Shape, heightInCm As String)
    MsgBox vsoShape.Name & " is " & heightInCm & " high", _
        vbInformation, "CallThisExamples.ModuleInStencil.p"
End Sub

Public Sub q(vsoShape As Visio.Shape, heightInCm As Double, widthInIU As Double)
    MsgBox vsoShape.Name & " is " & CStr(heightInCm) & " high by " & CStr(widthInIU) & " wide", _
        vbInformation, "CallThisExamples.ModuleInStencil.q"
End Sub

Testing Regional Settings in Visio

There are times that I have been caught out by assuming that everyone speaks “proper” English, like what I do (sic), and forgetting that there are other languages with their own formatting conventions. I think most of the world is bemused at the USA date format where they put the month before the day and…

Visio ShapeSheet Functions O-R

The fifth 33 of the Visio ShapeSheet functions that start with the letters O through to R are visually described in the Visio document below that is available for download. Please see the general introduction to this series at ShapeSheet Functions A-Z for more information. (more…)

Visio ShapeSheet Functions L-N

The fourth 34 of the Visio ShapeSheet functions that start with the letters L through to N are visually described in the Visio document below that is available for download. Please see the general introduction to this series at ShapeSheet Functions A-Z for more information. (more…)

Visio ShapeSheet Functions G-K

The third 26 of the Visio ShapeSheet functions that start with the letters G through to K are visually described in the Visio document below that is available for download. Please see the general introduction to this series at ShapeSheet Functions A-Z for more information. (more…)

Two Quote or Not Two Quote …

… that is the question! I have known for some time that it is safer to copy and paste code from the web into Notepad or similar, before copying and pasting that into my own code. It is not only new line characters that can be different but also the double-quotes. I recently noticed this…

Viewing Visio Document Changes in Git

Developing a Visio solution usually involves both .Net code and Visio ShapeSheet formulas. Good practice dictates that the source code is saved into a code repository, such as Git, where changes can be committed and commented. Visual Studio 2019 now includes native Git support, and can be linked to Azure DevOps easily. The code can…