【実務・中級編】【中級】ステンシル内のマスターシェイプに「独自のメタデータ」をVBAで付与する – Visio VBA解析バイブル

スポンサーリンク
スポンサーリンク

Visio VBAを掌握する極限の知見:マスターシェイプへのメタデータ注入による「生きたテンプレート」の構築

多くの開発者が、Visioを単なる「図面作成ツール」だと誤解している。しかし、我々アーキテクトの視点は異なる。Visioの本質は、「視覚的な表現力を備えた構造化データベース」だ。

業務自動化ツールを設計する際、最も致命的な設計ミスは、図面上の「個別のシェイプ」に対して値を書き込もうとすることだ。それでは、ユーザーが新しいシェイプをドラッグ&ドロップした瞬間に、せっかく構築したデータ構造は霧散する。

真に堅牢なシステムを構築するには、「マスターシェイプ(DNA)」に対して、プログラムからメタデータ(Shape Data)を定義・埋め込む必要がある。

本記事では、配布用ステンシルにカスタムプロパティを動的に、かつ確実に付与するための、プロダクションレベルの設計手法を伝授する。

1. 設計思想:インスタンスではなく「プロトタイプ」を制御せよ

Visioのオブジェクトモデルには、明確な階層構造がある。

1. Stencil (ステンシル): 形状の定義集合(テンプレートファイル)
2. Master (マスターシェイプ): ステンシル内に格納された、形状の「設計図」
3. Shape (シェイプ): 図面(Page)上に配置された、マスターの「実体(インスタンス)」

初心者は、図面上の `Shape` に対して `AddRow` を実行する。これは、製品が完成した後に部品の仕様を変更しようとするようなもので、極めて非効率でバグの温床となる。

プロフェッショナルは、`Master` に対してメタデータを定義する。マスターに定義された `Shape Data` は、そのマスターから生成されるすべてのインスタンスに自動的に継承される。これが「設計の正解」だ。

2. 実装における3つの技術的障壁

マスターシェイプを操作する際、以下の3点に直面する。これらを回避できないコードは、現場では「動かないコード」と同義だ。

① セクションの存在確認と重複防止

`ShapeData` セクションは、デフォルトでは存在しない場合がある。また、既存の行を上書きすべきか、新規追加すべきかのロジックが欠落していると、実行のたびに同じプロパティが重複して追加されるという醜態を晒すことになる。

② ステンシルの保護(Protection)

配布用のステンシルは、ユーザーによる誤操作を防ぐために保護されていることが多い。VBAから書き込む際は、一時的に `Protection` を解除し、書き込み後に即座に復元するという「トランザクション」の概念が必要だ。

③ データの型と列挙型

Shape Dataには「文字列」「数値」「日付」などの型がある。これらを適切に `Cell.Formula` へ流し込まなければ、後続の集計処理(Excel連携やDB格納)で型エラーを誘発する。

3. プロダクション・コード例:堅牢なメタデータ注入エンジン

以下に、定義済みのデータ構造に基づいて、ステンシル内のマスターシェイプにメタデータを注入する、保守性の高い実装例を示す。

Option Explicit

' メタデータの定義を管理するための構造体
Private Type MetaDefinition
    PropertyName As String
    InitialValue As String
    Label As String
End Type

''' <summary>
''' 指定したステンシルのマスターシェイプに対し、カスタムプロパティを定義する
''' </summary>
''' <param name="stencilName">対象のステンシル名 (.vssx)</param>
''' <param name="masterName">対象のマスター名</param>
Public Sub InjectMetadataToMaster(ByVal stencilName As String, ByVal masterName As String)
    Dim vApp As Visio.Application
    Dim vStencil As Visio.Stencil
    Dim vMaster As Visio.Master
    Dim vMetaList As Collection
    Dim vMeta As MetaDefinition
    
    Set vApp = Visio.Application
    
    ' 1. メタデータの定義(本来はDBや外部ファイルから取得すべき箇所)
    Set vMetaList = DefineMetadataSchema()
    
    On Error GoTo ErrorHandler
    
    ' 2. ステンシルの取得またはオープン
    ' 注意: すでに開いている場合はそれを使い、開いていない場合は開く設計にする
    Set vStencil = GetOrCreateStencil(vApp, stencilName)
    
    ' 3. マスターシェイプの取得
    On Error Resume Next
    Set vMaster = vStencil.Masters(masterName)
    On Error GoTo ErrorHandler
    
    If vMaster Is Nothing Then
        Err.Raise vbObjectError + 513, "InjectMetadata", "Master '" & masterName & "' not found."
    End If

    ' 4. 書き込みプロセス(トランザクション開始)
    Debug.Print "Starting injection for Master: " & masterName
    
    ' マスターの保護を一時解除(必要に応じて)
    ' ※マスター自体に保護がかかっている場合、ShapeSheetの操作に注意が必要
    
    For Each vMeta In CollectionToEnum(vMetaList)
        ApplyShapeDataToMaster vMaster, vMeta
    Next vMeta

    ' 5. ステンシルの保存(重要:これを忘れるとメモリ上の変更で終わる)
    vStencil.Save
    Debug.Print "Injection completed successfully."
    
    Exit Sub

ErrorHandler:
    MsgBox "Critical Error in Metadata Injection: " & Err.Description, vbCritical
    ' ここでログ出力やロールバックの処理を検討する
End Sub

''' <summary>
''' マスターシェイプに対して、行の存在を確認しつつデータを注入するコアロジック
''' </summary>
Private Sub ApplyShapeDataToMaster(ByRef targetMaster As Visio.Master, ByRef meta As MetaDefinition)
    Dim vShape As Visio.Shape
    ' マスターの「最初のインスタンス」を代表として使用してShapeDataセクションにアクセスする
    ' マスター自体にShapeDataを持たせるには、ShapeSheetを直接操作するのが定石
    
    ' マスターのShapeSheetにおけるShape Dataセクションを操作
    ' Masterのプロパティを操作する場合、便宜上、マスターの最初のシェイプに紐づく
    ' セクションインデックス 10 は通常 Shape Data セクション
    Const visSectionShapeData As Integer = 10
    
    ' マスターに紐づくShapeDataセクションを取得(ShapeSheet経由)
    ' ここでは、マスターの定義として確実にプロパティを刻むため、
    ' マスターから生成されるシェイプの挙動を制御する
    
    ' 実際の実装では、マスターのShapeSheetを直接操作するのが最も確実
    ' 下記は、マスターのShapeDataセクションへの行追加ロジック
    Dim rowIdx As Integer
    Dim section As Visio.Section
    Set section = targetMaster.Shapes(1).Section(visSectionShapeData) ' 代表シェイプ経由
    
    ' 既存行の確認
    rowIdx = -1
    Dim i As Integer
    For i = 0 To section.RowCount - 1
        If section.Row(i).ResultStr(visExists) = "1" Then
            ' プロパティ名が一致するか確認(Shape Dataのラベルではなく、内部名を確認)
            ' ここでは簡略化のため、名前の一致を確認
            If section.Row(i).Label = meta.PropertyName Then
                rowIdx = i
                Exit For
            End If
        End If
    Next i

    ' 行が存在しなければ追加、存在すれば更新
    If rowIdx = -1 Then
        rowIdx = section.AddRow(visRowLast, visTagDefault)
        section.Row(rowIdx).Label = meta.PropertyName
    End If
    
    ' 値の注入
    section.Row(rowIdx).ResultStr(visValue) = meta.InitialValue
    
    Debug.Print "  - Set '" & meta.PropertyName & "' to '" & meta.InitialValue & "'"
End Sub

''' <summary>
''' スキーマの定義(実務ではここを外部から注入する)
''' </summary>
Private Function DefineMetadataSchema() As Collection
    Dim col As New Collection
    Dim m1 As MetaDefinition, m2 As MetaDefinition, m3 As MetaDefinition
    
    m1.PropertyName = "AssetID": m1.InitialValue = "PENDING": m1.Label = "資産番号"
    m2.PropertyName = "Manufacturer": m2.InitialValue = "N/A": m2.Label = "メーカー"
    m3.PropertyName = "InstallDate": m3.InitialValue = "2023/01/01": m3.Label = "設置日"
    
    ' Collectionに格納(構造体は直接Collectionに入れられないため、ラッパーが必要な場合があるが
    ' ここでは概念を示すために簡略化)
    ' ※実際にはClass Moduleを作成してCollectionに入れるのがベストプラクティス
    ' 今回は解説用のため、概念的な処理とする
    Set DefineMetadataSchema = col ' (実際には実装が必要)
End Function

' --- 以下、ユーティリティ関数群 (省略) ---

*(注: 上記コードは概念を示すための抜粋です。実務では `MetaDefinition` を Class Module として定義し、`Collection` に格納してください。)*

4. アーキテクトの視点:運用フェーズでの注意点

コードを書いて終わりではない。この仕組みを実運用に乗せるには、以下の「守り」の設計が必要だ。

データベースとの同期(Single Source of Truth)

マスターシェイプの初期値をVBA内にハードコードしてはいけない。

  • NG: `m1.InitialValue = “ABC-123″`
  • OK: `m1.InitialValue = GetValueFromSQL(“SELECT asset_id FROM assets WHERE…”)`

マスターシェイプは「マスターデータ」の反映先であるべきだ。マスターを更新するプログラムは、常に外部の Single Source of Truth (信頼できる唯一の情報源) からデータを取得するように設計せよ。

バージョン管理の概念

ステンシル自体を「アセット」として管理せよ。
メタデータの構造(プロパティ名や型)を変更する場合、既存の図面(インスタンス)との互換性が壊れる。

  • プロパティ名を変更する際は、古いプロパティを削除するのではなく、`Deprecated_PropertyName` のように残すか、変換スクリプトを用意する。
  • ステンシルのファイル名にバージョン(`v1.0`, `v1.1`)を含める運用を強く推奨する。

パフォーマンスの最適化

数千のマスターを持つ大規模なステンシルを操作する場合、`Section.Row` のループは重くなる。
大量のプロパティを扱う場合は、`ShapeSheet` の `Formula` を一括で書き換える、あるいは `Application.ScreenUpdating = False` はもちろんのこと、オブジェクトモデルへのアクセス回数を最小限に抑える「バッチ処理」的な書き方を意識せよ。

結論

Visio VBAにおける真の自動化とは、単に「図形を動かすこと」ではない。「データの構造を、プログラムによって定義し、永続化すること」である。

マスターシェイプを制御下に置くことで、あなたの作成するツールは、単なる「便利ツール」から、企業の資産情報を正確に保持する「エンタープライズ・データ・プラットフォーム」へと昇華する。

設計に妥協するな。構造に魂を込めろ。

タイトルとURLをコピーしました