【実務・中級編】【上級】Visioアドイン開発を見据えたステンシル管理クラスの設計 – Visio VBA解析バイブル

Visio VBAを掌握する：ステンシル管理の極限設計 — 凡庸なマクロから「堅牢なアドイン」へ

Visioの自動化に取り組む者の多くが陥る罠がある。それは、「ステンシルを開き、シェイプをドロップし、終わり」という単発の処理を標準モジュールに書き連ねるという、あまりにナイーブなアプローチだ。

小規模なツールならそれで十分かもしれない。だが、数百のマスターシェイプを扱い、複雑なビジネスロジックを組み込み、不特定多数のユーザーに配布する「プロダクションレベル」のツールを開発する場合、その書き方は致命的な負債となる。

ステンシルの読み込みパスが変更されただけで全コードを書き直すのか？ シェイプ名の変更でランタイムエラーを吐き出すのか？ 処理が終わった後もメモリにゾンビのように残ったステンシルドキュメントを放置するのか？

プロのエンジニアは、Visioのオブジェクトモデルを直接叩かない。適切に抽象化された「管理クラス」を介して操作する。

本記事では、保守性と堅牢性を極限まで高めた「ステンシル管理クラス」の設計思想と、そのまま実戦投入可能な実装コードを伝授する。

1. 設計思想：なぜ「クラス化」が必要なのか

Visioにおけるステンシル（`.vssx`）は、単なる部品集ではない。それは一種の「読み取り専用ドキュメント」であり、ライフサイクル管理が必要なリソースである。

凡庸なコード（アンチパターン）

' 標準モジュールに直接書かれたコード
Set stn = Visio.Documents.OpenEx("C:\MyShapes.vssx", visOpenDocked)
Set shp = Visio.ActivePage.Drop(stn.Masters("ProcessBox"), 10, 10)
' ステンシルのクローズを忘れ、メモリを圧迫し、ファイルロックを発生させる

アーキテクトの視点（設計指針）

1. カプセル化: ステンシルのパスやマスター名という「文字列」をビジネスロジックから分離し、クラス内部に封じ込める。
2. リソース管理（シングルトン的アプローチ）: 同じステンシルを二度開こうとする無駄を省き、開いたリソースは確実に解放する。
3. エラーハンドリングの集約: 「ファイルが見つからない」「マスター名が変更された」という不整合を、個別のドロップ処理ではなく、ロード層で一括して検知・処理する。

2. 実装：`clsStencilManager` の構築

ここでは、ステンシルの読み込みからマスターの配置までを完結させるクラスを実装する。このクラスの肝は、「ステンシルドキュメントの参照を内部的に保持し、必要に応じてのみオープンする」点にある。

クラスモジュール名：`clsStencilManager`

Option Explicit

' --- メンバ変数 ---
Private pStencilDoc As Visio.Document
Private pStencilPath As String

' --- 初期化 ---
' @param stencilPath: ステンシルファイルへのフルパス
Public Sub Initialize(ByVal stencilPath As String)
    pStencilPath = stencilPath
    Set pStencilDoc = Nothing
End Sub

' --- マスターシェイプの配置 ---
' @param masterName: ステンシル内のマスター名
' @param x, y: 配置座標
' @return: 配置されたShapeオブジェクト
Public Function DropMaster(ByVal masterName As String, ByVal x As Double, ByVal y As Double) As Visio.Shape
    On Error GoTo ErrorHandler

    ' 1. ステンシルがロードされていない場合はロードする (Lazy Loading)
    If pStencilDoc Is Nothing Then
        LoadStencil
    End If

    ' 2. マスターの存在確認と配置
    ' Mastersコレクションから直接取得し、存在しない場合はエラーを投げる
    Dim master As Visio.Master
    Set master = pStencilDoc.Masters(masterName)
    
    If master Is Nothing Then
        Err.Raise vbObjectError + 513, "clsStencilManager", "指定されたマスター '" & masterName & "' が見つかりません。"
    End If

    ' ページへの配置
    Set DropMaster = Visio.ActivePage.Drop(master, x, y)
    Exit Function

ErrorHandler:
    ' ログ出力などのエラー処理をここに集約
    Debug.Print "Error in DropMaster: " & Err.Description
    Set DropMaster = Nothing
    Err.Raise Err.Number, "clsStencilManager", Err.Description
End Function

' --- 内部メソッド：ステンシルのロード ---
Private Sub LoadStencil()
    ' ファイル存在確認
    If Dir(pStencilPath) = "" Then
        Err.Raise vbObjectError + 514, "clsStencilManager", "ステンシルファイルが見つかりません: " & pStencilPath
    End If

    ' 既に開いているか確認し、なければ開く
    ' visOpenDockedではなくvisOpenRO(読み取り専用)で開くのが作法
    On Error Resume Next
    Set pStencilDoc = Visio.Documents.OpenEx(pStencilPath, visOpenRO + visOpenDocked)
    On Error GoTo 0

    If pStencilDoc Is Nothing Then
        Err.Raise vbObjectError + 515, "clsStencilManager", "ステンシルのオープンに失敗しました。"
    End If
End Sub

' --- リソース解放 ---
' ツール終了時やステンシル切り替え時に必ず呼ぶ
Public Sub Close()
    If Not pStencilDoc Is Nothing Then
        ' 保存せずに閉じる（重要：ステンシルを誤って更新させない）
        pStencilDoc.Close
        Set pStencilDoc = Nothing
    End If
End Sub

' --- 破棄時のクリーンアップ ---
Private Sub Class_Terminate()
    Close
End Sub

3. 実践的な運用：メインロジックからの呼び出し

クラス化したことで、メインロジックは「何を配置するか」というビジネスルールだけに集中できる。

標準モジュール例

Option Explicit

Public Sub BuildDiagram()
    Dim stnManager As clsStencilManager
    Set stnManager = New clsStencilManager
    
    ' 設定値は定数や外部設定ファイルから読み込むのが正解
    Const STENCIL_PATH As String = "C:\VisioAssets\BusinessProcess.vssx"
    
    On Error GoTo CleanUp
    
    ' 1. 初期化
    stnManager.Initialize STENCIL_PATH
    
    ' 2. 連続配置 (内部でLazy Loadingされるため、1回目でロード、2回目以降は高速)
    Dim shpStart As Visio.Shape, shpEnd As Visio.Shape
    
    Set shpStart = stnManager.DropMaster("StartEvent", 2.0, 10.0)
    Set shpEnd = stnManager.DropMaster("EndEvent", 5.0, 10.0)
    
    ' シェイプ間の接続処理など...
    If Not shpStart Is Nothing And Not shpEnd Is Nothing Then
        shpStart.AutoConnect shpEnd
    End If

CleanUp:
    ' リソースを確実に解放
    If Not stnManager Is Nothing Then
        stnManager.Close
        Set stnManager = Nothing
    End If
    
    If Err.Number <> 0 Then
        MsgBox "致命的なエラーが発生しました: " & Err.Description, vbCritical
    End If
End Sub

4. 極限の知見：さらに上のレベルへ行くための注意点

この設計をベースに、さらに大規模なツールへ拡張する場合、以下の3点に留意せよ。

① DB連携によるマッピングの自動化

マスター名をコードにハードコードするのは三流だ。
`[部品ID, マスター名, デフォルト座標]` を定義したSQLiteやExcelテーブルを用意し、ループ内で `stnManager.DropMaster` を回す設計にせよ。これにより、シェイプ名の変更はDBの値を書き換えるだけで完結し、VBAコードを触る必要はなくなる。

② パフォーマンスの壁：`Drop` メソッドの重さ

大量のシェイプ（数百個〜）を配置する場合、`Visio.ActivePage.Drop` は描画更新により極めて低速になる。

• 対策: `Visio.Application.ScreenUpdating = False` を併用せよ。ただし、これを忘れるとVisioがフリーズしたように見えるため、`On Error` 時に必ず `True` に戻すガードコードを徹底すること。

③ ファイルパスの動的解決

`C:\…` と絶対パスを書いた瞬間、そのツールはあなたのPCでしか動かなくなる。
`ThisWorkbook.Path` や環境変数を利用し、相対パスでステンシルを特定するロジックを `Initialize` 前に組み込むのがプロの作法である。

まとめ

Visio VBAにおけるステンシル管理の正解は、「リソースのライフサイクルを管理するクラスを構築し、メインロジックから物理的なファイル操作を隠蔽すること」にある。

この設計を導入することで、ランタイムエラーに怯える日々から解放され、真に価値のある「自動化ロジック」の構築に時間を割くことができるようになるはずだ。

コードを書きなぐる前に、設計を練れ。それが伝説的なエンジニアへの最短ルートである。