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

Setting Theme defaults in Visio

I was recently asked how to change the default font size and line weight in Visio, and then saw then many others are asking the same sort of question. I found one reasonable answer suggesting that you should create a new document from your required template, then edit the Styles to suit, and then save…

Taking Visio Actions Rows to the limit

I recently (re-)discovered that there is a limit to the number of Actions section rows that will be evaluated for display on the right mouse menu of a Visio shape. I have not hit a limit (yet) for the number of rows that can be added to the Actions section … so why is there…

A Multi-Time Zone Clock for Visio

I wrote a post about making a clock face in Visio fifteen years ago, but a reader recently asked about displaying multiple time zones. Well, I have previously written about time zones in Visio, so I accepted the challenge to improve upon my earlier work. (more…)

Update any Visio ShapeSheet cell with External Data

When Microsoft introduced a new way of linking external data to Visio shapes in 2007, I initially bemoaned the inability to update anything but Shape Data row values, unlike the old database add-on that I had been using for 10 years. The new method, though, has many advantages over the old way, not least that…

Referencing Container Data in Visio

Microsoft Visio has a useful Structured Diagramming concept that consists of Containers, Callouts and Connectors. The first of these features make it possible for shapes to know what they are contained within, as a better option to grouping shapes together. Grouping can hide or break the grouped shapes smartness, so Visio provides two ways of…

Understanding Morse Clicks with Visio

A few years ago, I wrote an article about messaging and encryption inspired by a visit to the National Museum of Computing in the UK. I developed a Morse Click shape to demonstrate how Visio can be used to represent and learn Morse Code. However, I never published the shapes here, and my good friend…