【実務・中級編】【中級】ステンシル内のマスターシェイプを「名前順」に並び替えてステンシルファイルを再保存する – Visio VBA解析バイブル

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

Visio VBA 極限の制御:ステンシル内のマスターシェイプを「名前順」に再構築し、UIの秩序を取り戻す設計論

業務自動化の現場において、ツールが「動く」ことと「使いやすい」ことの間には、深淵な断絶が存在します。

大量のマスターシェイプを抱えるステンシル(Stencil)を設計する際、多くの開発者はマスターを「追加する」ことだけに腐心し、その「並び順」を軽視します。しかし、エンジニアリングの現場で使われるツールにおいて、情報の検索性は生産性に直結します。マスターがバラバラに並んでいるステンシルは、ユーザーに対して「思考のノイズ」を強いる、設計ミスと言わざるを得ないプロダクトです。

本稿では、Visio VBAを用いてステンシル内のマスターシェイプを名前順に整列させ、秩序あるステンシルファイルとして再保存するための、堅牢かつプロフェッショナルな実装手法を解説します。

1. 陥りやすい設計の罠:なぜ「並び替え」は直接できないのか

多くの初級者が陥るミスは、`Stencil.Masters` コレクションに対して、あたかも配列のように `Sort` メソッドを適用しようとすることです。

結論から言えば、Visioのオブジェクトモデルにおいて、ステンシル内のマスターのインデックスを直接操作して並び替える命令は存在しません。

マスターの順序は、ステンシルファイル内の内部的な登録順序に依存しています。既存のステンシル内でマスターの順番を入れ替えるには、物理的に「マスターを一度削除し、正しい順序で再配置する」か、「新しいステンシルへ、正しい順序でコピーしていく」というアプローチを取る必要があります。

後者の「再構築(Reconstruction)パターン」こそが、副作用を最小限に抑え、ファイル構造をクリーンに保つための、アーキテクトが選択すべき正解です。

2. 実装戦略:Reconstruction Pattern

本ソリューションでは、以下のステップで処理を完結させます。

1. 抽出(Extraction): 対象のステンシルを開き、全マスターの名前を収集する。
2. ソート(Sorting): 収集した名前リストをアルファベット順(または定義したルール)でソートする。
3. 再構築(Reconstruction): 新しい一時的なステンシルを作成し、ソートされた順序に従って、元のステンシルからマスターを順次コピーする。
4. 永続化(Persistence): 完成したステンシルを所定のパスに保存する。

この設計により、元のステンシルの壊れたインデックスや不要なメタデータを排除し、純粋な「名前順のマスター群」を持つ新しいファイルを生成できます。

3. プロダクション・グレードのコード実装

以下に、実務での利用を想定した、エラーハンドリングとパフォーマンスを考慮したコードを示します。

Option Explicit

' ==============================================================================
' Module: StencilManager
' Description: ステンシルのマスターシェイプを名前順に整理する高度なユーティリティ
' ==============================================================================

''' <summary>
''' 指定されたステンシルファイルを読み込み、マスターを名前順に並び替えた新しいファイルを生成する。
''' </summary>
''' <param name="sourceFilePath">元のステンシルファイルのフルパス</param>
''' <param name="destinationFilePath">保存先のフルパス</param>
Public Sub ReorderStencilMastersByName(ByVal sourceFilePath As String, ByVal destinationFilePath As String)
    Dim vsoApplication As Visio.Application
    Dim sourceStencil As Visio.Stencil
    Dim destStencil As Visio.Stencil
    Dim masterList As Collection
    Dim masterName As Variant
    Dim targetMaster As Visio.Master
    Dim i As Long
    
    Set vsoApplication = Visio.Application
    
    ' 1. エラーハンドリングとファイル存在チェック
    If Dir(sourceFilePath) = "" Then
        Err.Raise vbErr_FileNotFound, "StencilManager", "ソースファイルが見つかりません: " & sourceFilePath
        Exit Sub
    End If

    On Error GoTo ErrorHandler
    
    ' 画面更新を停止してパフォーマンスを向上(描画負荷の軽減)
    vsoApplication.ScreenUpdating = False
    
    ' 2. ソースステンシルのオープン
    ' AttachStencilは既存のドキュメントに紐付けるため、
    ' ここでは「新しいドキュメント」にステンシルを読み込む挙動を想定
    Set sourceStencil = vsoApplication.Documents.OpenEx(sourceFilePath, visOpenDocked)
    
    ' 3. マスター名の収集
    Set masterList = New Collection
    For Each targetMaster In sourceStencil.Masters
        ' 非表示のマスターを除外するなどのフィルタリングロジックをここに入れることが可能
        If targetMaster.Name <> "" Then
            masterList.Add targetMaster.Name
        End If
    Next targetMaster
    
    ' 4. 名前リストのソート(簡易的なバブルソートの実装)
    ' ※大規模なマスター数(数百以上)の場合は、クイックソート等への差し替えを検討
    Call BubbleSortCollection(masterList)
    
    ' 5. 新しいステンシルの作成とマスターの再配置
    ' 新しいステンシルをメモリ上に作成
    Set destStencil = vsoApplication.Documents.AddStencil
    
    Debug.Print "--- Reordering Started ---"
    
    ' ソートされた名前順に、元のステンシルからコピーを実行
    For Each masterName In masterList
        ' 元のステンシルから対象のマスターを探す
        Set targetMaster = sourceStencil.Masters.Item(CStr(masterName))
        
        ' 新しいステンシルへマスターをコピー
        ' ※注意: CopyMasterはステンシルの構造を維持してコピーする
        targetMaster.Copy
        destStencil.Paste
        
        Debug.Print "Copied: " & masterName
    Next masterName
    
    ' 6. 保存とクリーンアップ
    ' 保存時に既存ファイルがある場合は上書き確認が必要(本コードでは強制上書きを想定)
    destStencil.SaveAs destinationFilePath
    
    ' 終了処理
    sourceStencil.Close
    destStencil.Close
    
    vsoApplication.ScreenUpdating = True
    MsgBox "ステンシルの再構築が完了しました。" & vbCrLf & destinationFilePath, vbInformation, "Success"
    
    Exit Sub

ErrorHandler:
    vsoApplication.ScreenUpdating = True
    MsgBox "致命的なエラーが発生しました。" & vbCrLf & _
           "Error Number: " & Err.Number & vbCrLf & _
           "Description: " & Err.Description, vbCritical, "Error"
End Sub

''' <summary>
''' Collection内の文字列を昇順にソートする(内部処理用)
''' </summary>
Private Sub BubbleSortCollection(ByRef col As Collection)
    Dim i As Long, j As Long
    Dim temp As Variant
    Dim arr() As String
    Dim count As Long
    
    count = col.count
    If count <= 1 Then Exit Sub
    
    ' Collectionを一旦配列に変換(ソート効率のため)
    ReDim arr(1 To count)
    For i = 1 To count
        arr(i) = col(i)
    Next i
    
    ' バブルソート
    For i = 1 To count - 1
        For j = i + 1 To count
            If StrComp(arr(i), arr(j), vbTextCompare) > 0 Then
                temp = arr(i)
                arr(i) = arr(j)
                arr(j) = temp
            End If
        Next j
    Next i
    
    ' 配列をCollectionに戻す
    col.Clear
    For i = 1 To count
        col.Add arr(i)
    Next i
End Sub

4. プロフェッショナルが意識すべき設計の勘所

このコードをプロダクション環境に投入するにあたり、以下の3点について設計思想を理解しておく必要があります。

① オブジェクトのライフサイクル管理

`sourceStencil` と `destStencil` は、メモリ上に存在するオブジェクトです。特に `OpenEx` で開いたステンシルは、処理が終わった後に明示的に `.Close` しなければ、Visioプロセスがステンシルを掴んだままになり、ファイルがロックされる原因となります。`ErrorHandler` 内でも必ずクリーンアップを行うのが、堅牢な設計の鉄則です。

② パフォーマンスの重み:`ScreenUpdating`

マスターのコピー・ペースト操作は、VisioのUI描画エンジンに対して大きな負荷をかけます。ループ内で描画を繰り返すと、処理時間は指数関数的に増大します。`vsoApplication.ScreenUpdating = False` は、単なる高速化テクニックではなく、ユーザーの作業環境をフリーズさせないための「作法」です。

③ 拡張性:ソートロジックの分離

上記のコードでは `BubbleSortCollection` というプライベートメソッドにソートロジックを分離しています。もし将来的に「数字を優先する(1, 2, 10, 20…)」や「特定の接頭辞を優先する」といった複雑な要件が出た場合でも、このメソッド内の `StrComp` を書き換えるだけで、メインロジックに一切手を加えずに対応可能です。これが「保守性の高いコード」の姿です。

結論

ステンシルの整理は、一見すると些細な「見た目の調整」に見えるかもしれません。しかし、大規模なプロジェクトにおいて、ユーザーが求めるマスターを瞬時に見つけ出せる環境を提供することは、ツールの価値そのものを決定づけます。

「単に動くコード」を書くフェーズを脱し、「構造的に正しく、運用に耐えうるコード」を書く。この一歩が、あなたを単なるプログラマーから、真のエンジニアへと進化させるのです。

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