【実務・中級編】【上級者向け】ページ追加時に「自動採番」を行うためのカウンター管理と、重複ページ名の防止策 – Visio VBA解析バイブル

Visio VBAを掌握する極限の知見：ページ命名規則の「聖域」を守るためのカウンター管理とバリデーション設計

業務自動化ツールの開発において、最も初歩的でありながら、最も多くのエンジニアが「設計の甘さ」を露呈するのが、オブジェクトの命名管理である。

特にMicrosoft Visioにおいて、ページ追加時に「自動採番」を実装しようとする際、多くの開発者はVisioの標準挙動に甘んじてしまう。ページ名が重複した瞬間にVisioが勝手に付与する `(1)` や `(2)` というサフィックス。これを見た瞬間、我々プロフェッショナルは戦慄する。なぜなら、それは「定義された命名規則の崩壊」を意味するからだ。

命名規則が崩れたデータは、もはや構造化データではない。後続のデータ解析、PDF出力、あるいは外部システムとの連携において、致命的なバグの温床となる。

本稿では、Visio VBAを用いて、独自の採番ロジックを強制し、重複を物理的に許さない堅牢なページ管理システムを構築するためのアーキテクチャを伝授する。

1. なぜ「Visio任せ」の設計は破綻するのか

Visioの内部挙動を理解していないエンジニアは、以下のようなコードを書く。

' 【アンチパターン：素人レベルのコード】
Sub AddPageBad()
    Dim newPage As Visio.Page
    Set newPage = ActiveDocument.Pages.Add
    newPage.Name = "Step_01" ' もし既に存在していたら、Visioが勝手に "Step_01_1" に変えてしまう
End Sub

このコードの最大の問題は、「状態（State）の管理をVisioというブラックボックスに委ねている」点にある。

プロフェッショナルな設計においては、以下の3原則を遵守しなければならない。
1. Single Source of Truth (SSOT): 次に発行すべき番号（カウンター）の正解は、プログラム側が完全に掌握すること。
2. Validation Before Action: オブジェクトを生成する「前」に、命名の妥当性を検証すること。
3. Idempotency (冪等性): 何度実行しても、予期せぬ命名の揺らぎが発生しないこと。

2. アーキテクチャ設計：カウンターの所在をどこに置くか

自動採番を実現するためには、現在のカウント数（State）をどこかに保持する必要がある。選択肢は主に3つだ。

実務における「配布用ツール」としての堅牢性とポータビリティを考慮すると、私は「隠しシェイプを用いたドキュメント内メタデータ管理」を強く推奨する。

3. プロダクション級の実装例

以下に、隠しシェイプを利用してカウンターを管理し、重複を完全に防ぐ、実戦投入可能なモジュールコードを示す。

このコードは、単にページを作るだけでなく、カウンターの初期化、読み取り、インクリメント、そしてページ名のバリデーションを一貫して行う「サービス層」として設計している。

Option Explicit

' ==============================================================================
' Module: PageManagerService
' Description: 堅牢なページ追加と自動採番を制御するサービスモジュール
' ==============================================================================

Private Const METADATA_PAGE_NAME As String = "_System_Metadata"
Private Const COUNTER_SHAPE_NAME As String = "_NextPageCounter"
Private Const NAME_PATTERN As String = "Project_Step_%02d" ' %02d は 01, 02... の形式

''' <summary>
''' 管理された新しいページを追加するメインエントリーポイント
''' </summary>
Public Sub AddManagedPage()
    On Error GoTo ErrorHandler
    
    Dim doc As Visio.Document
    Set doc = ActiveDocument
    
    ' 1. メタデータ管理用ページがなければ作成（初期化）
    EnsureMetadataExists doc
    
    ' 2. 次のページ名を取得
    Dim nextName As String
    nextName = GetNextValidPageName(doc)
    
    ' 3. ページを追加
    Dim newPage As Visio.Page
    Set newPage = doc.Pages.Add
    
    ' 4. 命名の適用
    newPage.Name = nextName
    
    ' 5. カウンターをインクリメント
    IncrementCounter doc
    
    MsgBox "ページ '" & nextName & "' を正常に作成しました。", vbInformation
    Exit Sub

ErrorHandler:
    MsgBox "致命的なエラーが発生しました: " & Err.Description, vbCritical, "Error"
End Sub

''' <summary>
''' 次に発行すべき、かつ重複のないページ名を算出する
''' </summary>
Private Function GetNextValidPageName(doc As Visio.Document) As String
    Dim currentCount As Integer
    Dim candidateName As String
    Dim i As Integer
    
    currentCount = GetCurrentCounter(doc)
    
    ' 衝突回避のためのバリデーションループ（念のためのガード）
    ' 実際にはカウンターが正しければ衝突しないはずだが、
    ' ユーザーによる手動改名などを考慮した「二重防御」を行う
    For i = 0 To 100 ' 無限ループ防止のセーフティ
        candidateName = Format(currentCount + i, NAME_PATTERN)
        
        If Not IsPageNameExists(doc, candidateName) Then
            GetNextValidPageName = candidateName
            Exit Function
        End If
    Next i
    
    Err.Raise vbObjectError + 513, "PageManager", "命名可能なページ名が枯渇しました。"
End Function

''' <summary>
''' ページ名が既に存在するかどうかを判定する
''' </summary>
Private Function IsPageNameExists(doc As Visio.Document, targetName As String) As Boolean
    Dim pg As Visio.Page
    For Each pg In doc.Pages
        If pg.Name = targetName Then
            IsPageNameExists = True
            Exit Function
        End If
    Next pg
    IsPageNameExists = False
End Function

''' <summary>
''' 隠しシェイプから現在のカウンター値を取得する
''' </summary>
Private Function GetCurrentCounter(doc As Visio.Document) As Integer
    Dim metaPage As Visio.Page
    Dim shp As Visio.Shape
    
    On Error Resume Next
    Set metaPage = doc.Pages(METADATA_PAGE_NAME)
    If metaPage Is Nothing Then
        GetCurrentCounter = 1
        Exit Function
    End If
    
    Set shp = metaPage.Shapes(COUNTER_SHAPE_NAME)
    If shp Is Nothing Then
        GetCurrentCounter = 1
    Else
        GetCurrentCounter = CInt(shp.Text)
    End If
    On Error GoTo 0
End Function

''' <summary>
''' カウンターをインクリメントする
''' </summary>
Private Sub IncrementCounter(doc As Visio.Document)
    Dim metaPage As Visio.Page
    Dim shp As Visio.Shape
    Dim nextVal As Integer
    
    Set metaPage = doc.Pages(METADATA_PAGE_NAME)
    Set shp = metaPage.Shapes(COUNTER_SHAPE_NAME)
    
    nextVal = CInt(shp.Text) + 1
    shp.Text = CStr(nextVal)
End Sub

''' <summary>
''' メタデータ管理用ページとシェイプを初期化する
''' </summary>
Private Sub EnsureMetadataExists(doc As Visio.Document)
    Dim metaPage As Visio.Page
    Dim shp As Visio.Shape
    
    On Error Resume Next
    Set metaPage = doc.Pages(METADATA_PAGE_NAME)
    On Error GoTo 0
    
    ' ページが存在しない場合は作成
    If metaPage Is Nothing Then
        Set metaPage = doc.Pages.Add
        metaPage.Name = METADATA_PAGE_NAME
        metaPage.Visible = False ' ユーザーに見えないよう隠蔽（ただし完全な非表示ではない）
        ' ページ自体を非表示にする属性はVisioのバージョンに依存するため、
        ' ロジック上「無視されるページ」として扱う設計にする
    End If
    
    ' カウンター用シェイプが存在しない場合は作成
    On Error Resume Next
    Set shp = metaPage.Shapes(COUNTER_SHAPE_NAME)
    On Error GoTo 0
    
    If shp Is Nothing Then
        Set shp = metaPage.DrawRectangle(0, 0, 1, 1)
        shp.Name = COUNTER_SHAPE_NAME
        shp.Text = "1"
        shp.Visible = False ' シェイプを非表示に
    End If
End Sub

4. チーフアーキテクトによる設計解説

このコードがなぜ「プロダクション級」なのか。その設計思想を解説する。

1. 二重防御（Double Defense）戦略

`GetNextValidPageName` 関数に注目してほしい。カウンターから取得した名前をそのまま信じるのではなく、`IsPageNameExists` を使って実際にドキュメント内を走査し、衝突がないことを確認している。これは、ユーザーが手動でページ名を書き換えた場合でも、システムが壊れないための「防御的プログラミング」である。

2. 隠蔽化（Encapsulation）

メタデータ管理用のページ名に `_System_Metadata` というプレフィックスを付けている。これにより、将来的に「システム用ページを除外して処理する」といったロジックを容易に組み込める。また、シェイプを非表示にすることで、一般ユーザーの操作ミスによるカウンター破壊のリスクを最小限に抑えている。

3. エラーハンドリングの厳格化

`On Error Resume Next` を乱用してはならない。このコードでは、カウンターの取得やメタデータの存在確認といった「失敗が予測される箇所」にのみ限定して使用し、それ以外は `ErrorHandler` によって適切に捕捉されるように設計している。

4. パフォーマンスへの配慮

ページ数が増大した場合、`For Each pg In doc.Pages` による走査は $O(n)$ の計算量を持つ。もし数千ページ規模の巨大なドキュメントを扱う場合は、この走査を避けるために、前述の「外部データベース」への移行を検討すべきだ。しかし、通常の業務図面（数百ページ程度）であれば、この実装が最もメンテナンスコストとパフォーマンスのバランスに優れている。

結論

Visio VBAによる自動化において、単に「動くもの」を作るのは初級者だ。
「壊れないもの」を、予測可能な状態で作り上げるのが我々プロフェッショナルの仕事である。

命名規則をシステム側で完全に統制すること。それは、単なる整理整頓ではなく、データとしての整合性を担保するための、エンジニアリングにおける「防波堤」なのだ。