【テクニカル・上級編】【上級者向け】VSDXファイル内の「Document_BeforeDocumentSave」イベントを動的にフックし、保存内容を検証する – Visio VBA解析バイブル

VSDXファイル保存イベントを制圧する：Document_BeforeDocumentSaveイベントを動的にフックし、データ整合性を血肉化する究極の技法

長年、VBAとレガシーシステムの世界で血と汗を流してきた者なら、Visioの図面ファイル（VSDX）が単なる「絵」ではなく、ビジネスロジックとデータが息づく「生きたドキュメント」であると理解しているはずだ。そして、その「生命線」とも言える保存処理において、予期せぬデータ不整合や仕様漏れが紛れ込むリスクに、幾度となく頭を悩ませてきたことだろう。

今回、我々が探求するのは、Visio VBAの奥深くに眠る「Document_BeforeDocumentSave」イベントを、まるで自らの意思であるかのように動的にフックし、保存される内容そのものを「検証」し、必要ならば「阻止」するという、まさに職人技とも言える領域だ。これは、単なるイベントハンドリングの範疇を超え、VSDXファイルという「器」の integrity を、保存という「瞬間」に保証するための、究極のアーキテクチャ制御と言える。

なぜ「Document_BeforeDocumentSave」なのか？ その本質を理解する

多くの開発者は、保存後のイベント（例えば `Document_AfterDocumentSave`）や、単純なボタンクリックイベントで「検証」を行おうとする。しかし、それは既に「手遅れ」なのだ。データ不整合がVSDXファイルに書き込まれてしまった後では、その修正は困難を極め、場合によってはファイル破損のリスクすら孕む。

「Document_BeforeDocumentSave」イベントは、Visioが実際にディスクにデータを書き込む「直前」に発生する。この「直前」というタイミングが極めて重要だ。このイベント内で、我々は保存されるべきデータの内容を精査し、もし仕様に合致しない、あるいは必須情報が欠落しているといった「不備」を発見した場合、保存処理そのものをキャンセルすることができる。これにより、VSDXファイルには常に「整合性の取れた」データのみが書き込まれるという、絶対的な安全網を構築できるのだ。

クラスモジュールによる「動的フック」：オブジェクト指向の粋を結集する

さて、この「Document_BeforeDocumentSave」イベントを「動的に」フックする、というのが我々のミッションだ。Visio VBAの標準的なイベントハンドラは、通常、標準モジュールに記述され、特定のイベントが発生した際に自動的に呼び出される。しかし、我々が目指すのは、より高度で、柔軟な制御だ。

そこで鍵となるのが「クラスモジュール」の活用である。クラスモジュールは、オブジェクト指向プログラミングの根幹をなし、データとそれを操作するメソッドをカプセル化する。このクラスモジュールに、Visioアプリケーションオブジェクトのイベントを「購読」する仕組みを実装することで、あたかもVisioアプリケーション自体に「意思」を持たせるかのような、高度な制御が可能になる。

具体的には、以下のような流れで実装を進める。

1. イベント購読用クラスの定義: Visioアプリケーションオブジェクトからのイベントを受け取るためのクラスを定義する。このクラスは、`WithEvents` キーワードを使用して、特定のオブジェクト（この場合は Visio Application）のイベントを「監視」する。
2. イベントハンドラの実装: 定義したクラス内に、`Document_BeforeDocumentSave` イベントに対応するプロシージャを実装する。このプロシージャ内で、保存内容の検証ロジックを記述する。
3. アプリケーションオブジェクトへのバインド: Visioアプリケーションの起動時などに、このイベント購読用クラスのインスタンスを生成し、Visioアプリケーションオブジェクトに紐づける。

この「動的フック」の利点は、単にイベントを捕捉するだけでなく、必要に応じてイベントハンドラの追加・削除、あるいは検証ロジックの動的な変更を可能にする点にある。これは、複雑なシステム連携や、刻々と変化するビジネス要件に対応する上で、計り知れない価値を持つ。

実践：VBAコードによる「Document_BeforeDocumentSave」イベントの動的フック

それでは、具体的なVBAコードを見ていこう。ここでは、クラスモジュール `CVisioEventHandler` を作成し、Visioアプリケーションの `Document_BeforeDocumentSave` イベントをフックする例を示す。

まず、クラスモジュール「CVisioEventHandler.cls」 を作成し、以下のコードを記述する。

‘==============================================================================
‘ クラスモジュール: CVisioEventHandler.cls
‘ 説明: Visio Application オブジェクトのイベントを処理するためのクラス。
‘ 特に、ドキュメント保存前の検証処理を実装する。
‘==============================================================================

‘ WithEvents キーワードにより、引数 objApp のイベントを監視する
Public WithEvents VisioApp As Visio.Application

‘==============================================================================
‘ イベント: Document_BeforeDocumentSave
‘ 説明: ドキュメントが保存される直前に呼び出される。
‘ ここで、保存内容の検証を行い、必要に応じて保存をキャンセルする。
‘==============================================================================
Private Sub VisioApp_Document_BeforeDocumentSave(ByVal doc As Visio.Document, ByRef Handled As Integer)
Dim blnCancelSave As Boolean
Dim shp As Visio.Shape
Dim pg As Visio.Page
Dim msg As String
Dim lngShapeCount As Long
Dim blnMandatoryDataFound As Boolean

‘ 初期化
blnCancelSave = False
msg = “”
lngShapeCount = 0
blnMandatoryDataFound = False

‘ — ここからが、保存内容検証のコアロジック —
‘ 例: 特定のページに、最低1つの「必須データ」を持つシェイプが存在するかチェックする

On Error GoTo ErrorHandler ‘ エラーハンドリング

‘ 現在アクティブなドキュメントのページをループ
For Each pg In doc.Pages
‘ 特定のページ名やプロパティでフィルタリングしても良い
‘ If pg.Name = “MyMandatoryDataPage” Then

‘ ページ内のシェイプをループ
For Each shp In pg.Shapes
lngShapeCount = lngShapeCount + 1

‘ シェイプのカスタムプロパティやセクションで「必須データ」を判定
‘ 例: ShapeSheet の User-Defined Cells に “IsMandatoryData” という名前で TRUE が設定されているか
If shp.CellsU(“Prop.IsMandatoryData”).ResultIU = 1 Then
blnMandatoryDataFound = True
‘ 必須データが見つかったので、このページでのチェックは完了
Exit For
End If
Next shp

‘ 必須データが見つかったら、このドキュメント全体のチェックも完了
If blnMandatoryDataFound Then Exit For
‘ End If
Next pg

‘ — 検証結果に基づいた処理 —
If Not blnMandatoryDataFound Then
blnCancelSave = True
msg = “エラー: 図面内の必須データが入力されていません。” & vbCrLf & _
“保存をキャンセルします。データを入力してから再度保存してください。”
Else
‘ 他の検証ロジックを追加可能
‘ 例: 特定のシェイプのテキストが空でないか、など
‘ If lngShapeCount < 10 Then ' blnCancelSave = True ' msg = "警告: 図面内のシェイプ数が想定より少ないです。保存を続行しますが、確認してください。" ' End If End If ' --- 保存のキャンセル処理 --- If blnCancelSave Then ' Handled パラメータを 1 に設定すると、保存処理がキャンセルされる Handled = 1 MsgBox msg, vbExclamation, "保存エラー" ' オブジェクトの解放（後述） Set shp = Nothing Set pg = Nothing Exit Sub End If ' --- オブジェクトの解放 --- ' 正常に保存が続行される場合でも、オブジェクトは適切に解放する Set shp = Nothing Set pg = Nothing ' 正常終了 Exit Sub ErrorHandler: ' エラー発生時の処理 MsgBox "予期せぬエラーが発生しました。エラー番号: " & Err.Number & ", 説明: " & Err.Description, vbCritical, "イベント処理エラー" Handled = 1 ' エラー発生時も保存をキャンセルする ' エラー発生時も、可能な限りオブジェクトを解放する On Error Resume Next ' エラーハンドリング内でさらにエラーが発生しても続行 Set shp = Nothing Set pg = Nothing On Error GoTo 0 ' エラーハンドリングを終了 End Sub '============================================================================== ' デストラクタ相当の処理: クラスインスタンスが解放されるときに呼び出される '============================================================================== Private Sub Class_Terminate() ' ここで VisioApp オブジェクトへの参照をクリアする ' このメソッドは、クラスインスタンスがメモリから解放される際に自動的に呼び出される ' Set VisioApp = Nothing ' これは、インスタンスの生成元で適切に処理されるべき Debug.Print "CVisioEventHandler インスタンスが解放されました。" End Sub 次に、標準モジュール（例: 「Module1」） を作成し、以下のコードを記述して、クラスインスタンスの生成と、Visioアプリケーションオブジェクトへのバインドを行う。

‘==============================================================================
‘ 標準モジュール: Module1
‘ 説明: CVisioEventHandler クラスのインスタンスを管理し、Visio Application オブジェクトにバインドする。
‘==============================================================================

‘ グローバル変数として、イベントハンドラクラスのインスタンスを保持する
‘ このインスタンスは、Visioアプリケーションのライフサイクル全体で有効である必要がある
Public g_EventHandler As CVisioEventHandler

‘==============================================================================
‘ サブルーチン: InitializeEventHandler
‘ 説明: Visio Application オブジェクトにイベントハンドラを初期化・バインドする。
‘ Visio の起動時や、図面を開いた際に呼び出すことを想定。
‘==============================================================================
Sub InitializeEventHandler()
‘ 既にインスタンスが存在する場合は、何もしない（二重登録の防止）
If Not g_EventHandler Is Nothing Then
Exit Sub
End If

‘ CVisioEventHandler クラスの新しいインスタンスを生成
Set g_EventHandler = New CVisioEventHandler

‘ 生成したインスタンスに、現在の Visio Application オブジェクトを紐づける
‘ WithEvents キーワードで定義された VisioApp プロパティに、
‘ Visio の Application オブジェクトを代入することで、イベントの購読が開始される
Set g_EventHandler.VisioApp = Visio.Application

Debug.Print “Visio イベントハンドラが初期化され、バインドされました。”
End Sub

‘==============================================================================
‘ サブルーチン: UninitializeEventHandler
‘ 説明: イベントハンドラを解除し、リソースを解放する。
‘ Visio の終了時などに呼び出すことを想定。
‘==============================================================================
Sub UninitializeEventHandler()
‘ イベントハンドラインスタンスが存在する場合のみ処理を実行
If Not g_EventHandler Is Nothing Then
‘ VisioApp への参照をクリアすることで、イベントの購読を解除する
‘ これにより、VisioApp_Document_BeforeDocumentSave プロシージャが
‘ 今後呼び出されなくなる
Set g_EventHandler.VisioApp = Nothing

‘ クラスインスタンス自体を解放する
‘ これにより、Class_Terminate プロシージャが呼び出される
Set g_EventHandler = Nothing
Debug.Print “Visio イベントハンドラが解除され、リソースが解放されました。”
End If
End Sub

‘==============================================================================
‘ サブルーチン: Auto_Open
‘ 説明: Visio が起動されたときに自動的に実行される。
‘ イベントハンドラを初期化するために使用。
‘==============================================================================
Sub Auto_Open()
InitializeEventHandler
End Sub

‘==============================================================================
‘ サブルーチン: Auto_Close
‘ 説明: Visio が終了するときに自動的に実行される。
‘ イベントハンドラを解除するために使用。
‘==============================================================================
Sub Auto_Close()
UninitializeEventHandler
End Sub

コードの解説と補足:

• `CVisioEventHandler` クラス:
• `Public WithEvents VisioApp As Visio.Application`: この行が、クラスモジュールが Visio Application オブジェクトのイベントを「監視」するための鍵です。`WithEvents` キーワードは、このクラスのインスタンスが `VisioApp` プロパティに割り当てられた `Visio.Application` オブジェクトのイベントを自動的に処理することを宣言します。
• `Private Sub VisioApp_Document_BeforeDocumentSave(…)`: `VisioApp` オブジェクトで `Document_BeforeDocumentSave` イベントが発生すると、このプロシージャが自動的に呼び出されます。
• `ByRef Handled As Integer`: このパラメータが重要です。このパラメータに `1` を設定することで、Visio は保存処理をキャンセルします。`0` のまま（デフォルト）であれば、保存は続行されます。
• 検証ロジック: コード例では、単純な例として、図面内に「必須データ」を持つシェイプが存在するかどうかをチェックしています。実際のシステムでは、ShapeSheet のセル（`Prop.XXX` や `User.XXX`）を参照したり、シェイプのテキスト内容を解析したり、より複雑な条件で検証を行うことになります。
• `ErrorHandler`: 予期せぬエラーが発生した場合でも、保存処理が強制的に実行されることを防ぎ、エラーメッセージを表示して保存をキャンセルするための基本的なエラーハンドリングです。
• `Class_Terminate()`: クラスインスタンスがメモリから解放される際に自動的に呼び出されるメソッドです。ここで、`VisioApp` への参照を解放するなどのクリーンアップ処理を行うことが推奨されます。ただし、`WithEvents` で宣言されたオブジェクトへの参照は、インスタンス自身が破棄される際に自動的にクリーンアップされることが多いです。

• 標準モジュール（`Module1`）:
• `Public g_EventHandler As CVisioEventHandler`: クラスインスタンスを、VBAプロジェクト全体でアクセス可能なグローバル変数として保持します。これにより、インスタンスが意図せず解放されるのを防ぎます。
• `InitializeEventHandler()`: このサブルーチンは、`CVisioEventHandler` のインスタンスを生成し、`Visio.Application` オブジェクトに紐づけます。`WithEvents` の効果を発揮させるには、このバインドが不可欠です。
• `UninitializeEventHandler()`: イベントハンドラを解除し、リソースを解放します。`Set g_EventHandler.VisioApp = Nothing` が、イベントの購読を解除する操作に相当します。
• `Auto_Open()` / `Auto_Close()`: これらのサブルーチンは、Visio が起動または終了する際に Visio VBA によって自動的に実行されるように設計されています。これにより、Visio のライフサイクルとイベントハンドラのライフサイクルを同期させることができます。

メモリ最適化とオブジェクトのライフサイクル管理：レガシーシステム保守の神髄

長年VBAシステムやレガシーアーキテクチャに携わってきた者であれば、メモリリークや不要なリソースの占有がいかにシステムを不安定にするか、痛感しているはずだ。我々が構築するシステムは、安定稼働が最優先であり、そのためにはオブジェクトのライフサイクルを厳密に管理する必要がある。

上記のコード例におけるメモリ管理のポイントは以下の通りだ。

• `WithEvents` とオブジェクト参照の解除: `CVisioEventHandler` クラスの `VisioApp` プロパティは `WithEvents` で宣言されている。このプロパティに `Visio.Application` オブジェクトへの参照が保持されている間、そのオブジェクトのイベントを処理できる。イベントハンドラを解除するには、`Set g_EventHandler.VisioApp = Nothing` を実行し、参照をクリアする必要がある。これにより、Visio Application オブジェクトへの不要な参照が残り続けることを防ぐ。
• クラスインスタンスの解放: `Set g_EventHandler = Nothing` を実行することで、`CVisioEventHandler` クラスのインスタンス自体を解放する。これにより、`Class_Terminate()` メソッドが呼び出され、クラス内で定義されたクリーンアップ処理が実行される。
• ループ内でのオブジェクト解放: `For Each` ループ内で使用される `shp` や `pg` といったオブジェクトは、ループの終了後（あるいは `Exit For` などでループを抜ける際）に `Set shp = Nothing`、`Set pg = Nothing` のように明示的に解放することが推奨される。これは、特に大規模な図面や多数のシェイプを処理する場合に、メモリ使用量を抑える上で効果的である。`On Error GoTo ErrorHandler` ブロック内でも、同様に `On Error Resume Next` を使用してエラー発生時でもオブジェクト解放を試みることで、リソースリークのリスクを最小限に抑える。
• `Auto_Open` / `Auto_Close` の活用: Visio の起動・終了時にイベントハンドラを自動的に初期化・解除することで、ユーザーが明示的に操作することなく、常に適切な状態を維持できる。これは、エンドユーザーにとっての利便性向上だけでなく、システム管理の観点からも重要である。

Windows APIとの連携：秘匿された機能を呼び覚ます

VBA単体では実現が難しい高度な機能や、より低レベルなシステム制御が必要な場合、Windows APIの呼び出しが不可欠となる。例えば、

• プロセスの管理: 特定のVisioプロセスが起動しているかを確認したり、必要に応じてプロセスを終了させたりする。
• ファイルシステムの操作: ファイルのロック状態を確認したり、特定のディレクトリへの書き込み権限をチェックしたりする。
• メッセージループの制御: より洗練されたUI制御や、非同期処理の管理。

`Document_BeforeDocumentSave` イベントのフックという文脈で直接APIを呼び出す場面は少ないかもしれないが、例えば、保存前に特定の共有フォルダへの書き込み権限をAPIで詳細にチェックしたり、あるいは、保存処理が遅延している場合に、ユーザーに明確なフィードバックを与えるためにAPI経由でダイアログを表示したり、といった応用が考えられる。

VBAからWindows APIを呼び出すには、`Declare` ステートメントを使用する。

‘ Windows API Declare ステートメントの例
‘ エラーコードを取得するための API
Declare PtrSafe Function GetLastError Lib “kernel32” () As Long

‘ メッセージボックスを表示するための API (VBAのMsgBoxよりも詳細な制御が可能)
‘ Declare PtrSafe Function MessageBoxW Lib “user32” ( _
‘ ByVal hWnd As LongPtr, _
‘ ByVal lpText As LongPtr, _
‘ ByVal lpCaption As LongPtr, _
‘ ByVal uType As Long) As Long

API呼び出しは強力な反面、引数の型や呼び出し規約（`PtrSafe` など）を間違えると、アプリケーションがクラッシュするリスクも伴う。そのため、APIドキュメントを熟読し、細心の注意を払って実装する必要がある。特に、64bit環境での互換性を考慮した `PtrSafe` キーワードの利用は、現代のシステム開発においては必須と言える。

レガシー環境の保守とシステム間連携：盤石な基盤を築く

我々が扱うVBAシステムやレガシーアーキテクチャは、しばしば長期間にわたって稼働し、その保守性は極めて重要だ。今回解説した「Document_BeforeDocumentSave」イベントの動的フックは、以下のような点でレガシー環境の保守に貢献する。

• 既存システムへの影響最小化: 新規の検証ロジックを、既存のVisio図面ファイルやVBAコードに大きな変更を加えることなく、後から「追加」できる。これは、大規模な改修が困難なレガシーシステムにおいては、非常に有効なアプローチだ。
• データ整合性の保証: 保存時のデータ不整合は、後続のシステム（データベース、ERP、MESなど）に深刻な影響を与える可能性がある。このイベントフックにより、Visio図面ファイルが「唯一の真実の情報源」として、常に最新かつ整合性の取れた状態を保つことができる。
• システム間連携の強化: 例えば、Visio図面内の特定の要素（シェイプのプロパティなど）が、外部データベースのレコードと同期している場合、保存時にその同期が正しく行われているか、あるいは、外部データとの整合性を保てる内容になっているかを検証できる。これにより、システム間のデータ一貫性を、より強固に保証することが可能になる。

まとめ：Visio VBAの支配者たれ

「Document_BeforeDocumentSave」イベントを動的にフックし、保存内容を検証・制御する技術は、Visio VBAの可能性を極限まで引き出すための、まさに「職人芸」である。クラスモジュールを駆使した動的フック、厳密なオブジェクトライフサイクル管理、そして必要に応じたWindows APIの連携。これらを組み合わせることで、我々はVisio図面ファイルという「生きたドキュメント」の integrity を、保存という「瞬間」に保証し、ビジネスロジックの血肉化を実現する。

この技術は、単なる「便利機能」ではない。それは、データ整合性を絶対視し、システム全体の信頼性を揺るぎないものにするための、アーキテクチャ上の「哲学」である。レガシーシステムであっても、この深淵な技術を理解し、適用することで、我々はより堅牢で、より信頼性の高いシステムを構築し、ビジネスの根幹を支え続けることができるのだ。

さあ、あなたもVisio VBAの支配者となり、図面ファイルに宿るデータに絶対的な秩序をもたらしてほしい。