【テクニカル・上級編】【中級者向け】「コメント」や「脚注」内を検索対象に含めるためのStoryRanges巡回テクニック – Word VBA解析バイブル

スポンサーリンク

StoryRangesの全域掌握:Word文書の「迷宮」を完全踏破する検索・置換アーキテクチャ

Word VBAにおける検索・置換(`Find` / `Replacement`)は、一見すると単純なUI操作の自動化に映る。しかし、システム開発の現場で「文書内の全文字列を一括置換せよ」という要件に直面した瞬間、多くのエンジニアは絶望の淵に立たされる。

`Selection.Find` や `ActiveDocument.Content.Find`。これらはメイン本文(wdMainTextStory)しか走査しない。
ヘッダー、フッター、脚注(Footnotes)、文末脚注(Endnotes)、そして最も厄介な「コメント(Comments)」に取り残された文字列は、容赦なく検索漏れの闇に消える。

Wordの内部アーキテクチャにおいて、文書は単一の連続したテキストブロックではない。「ストーリー(Story)」と呼ばれる独立したテキスト領域のコレクションによって構成されている。

本稿では、Word VBAの隠された実体である `StoryRanges` コレクションを完全に制御し、あらゆる文書の隅々まで検索・置換を貫徹するための極限の知見を授ける。

—

1. Wordアーキテクチャの核心:なぜ `Content.Find` では不十分なのか?

Wordのデータ構造を理解するには、オブジェクト指向の階層構造だけでなく、メモリ上の「領域(Story)」の概念が不可欠である。

Word文書は、以下の異なるストーリーが複雑に絡み合ったグラフ構造体としてメモリ上に展開される。

  • wdMainTextStory: メイン本文
  • wdHeaderStory / wdEvenPagesHeaderStory / wdFirstPageHeaderStory: ヘッダー群
  • wdFooterStory / wdEvenPagesFooterStory / wdFirstPageFooterStory: フッター群
  • wdFootnotesStory / wdEndnotesStory: 脚注・文末脚注
  • wdCommentsStory: コメント(変更履歴や校閲コメント)
  • wdTextboxStory: テキストボックス群(※後述のトラップあり)

通常の `Find` オブジェクトは、メソッドを実行した「現在のストーリーレンジ」にしか作用しない。したがって、文書全体を網羅するには、`ActiveDocument.StoryRanges` というイテレータを回し、すべてのサブストーリーを明示的に巡回しなければならないのだ。

—

2. StoryRanges巡回における「3大トラップ」とエンジニアリング的解決

シニアエンジニアが `StoryRanges` を扱う際、必ず直面する致命的な罠が3つ存在する。これらを回避できなければ、実業務のシステムでメモリリークや無限ループを引き起こす。

トラップ①:`Next` プロパティによる鎖状連結の限界

`StoryRanges` コレクションの各要素は、`.Next` ポインタによって単方向リストのように鎖状につながっている。しかし、このリストはすべてのストーリーを網羅しているわけではない。特に、セクションごとのヘッダー/フッターや、リンクされていない個別のストーリーは、この鎖から漏れ落ちる。

トラップ②:テキストボックス(`wdTextboxStory`)の孤立

`wdTextboxStory` や図形内のテキストは、`StoryRanges` の標準イテレータでは列挙されないことが多い。これらを捕捉するには、文書内のシェイプ(`Shapes` および `InlineShapes`)を再帰的に走査し、その `TextFrame` から個別に `Find` を実行する必要がある。

トラップ③:メモリリークとCOMオブジェクトの解放

VBAはガベージコレクタの挙動がブラックボックスであり、特にWordのRangeオブジェクトやFindオブジェクトをループ内で不適切に生成・破棄すると、COMコンポーネントの参照カウントがリークし、ExcelやWordプロセスがゾンビ化する。

—

3. 【実装】全ストーリー完全網羅・高速置換エンジンの構築

ここに示すのは、実務のエンタープライズ環境に耐えうる、堅牢性とパフォーマンスを極限まで高めた検索・置換プロシージャである。エラーハンドリング、オブジェクトの明示的解放、そしてテキストボックスの網羅的走査を完備している。

Option Explicit

‘ =================================================================================
‘ 汎用文書横断 検索・置換エンジン (Enterprise Grade)
‘ =================================================================================
Public Sub ExecuteEnterpriseFindReplace(ByVal targetDoc As Document, _
ByVal findText As String, _
ByVal replaceText As String)

Dim rngStory As Range
Dim shp As Shape
Dim inShp As InlineShape
Dim lngCount As Long

‘ パフォーマンス向上のための画面描画・イベント抑制
With Application
.ScreenUpdating = False
.DisplayAlerts = wdAlertsNone
.Calculation = wdCalculationManual
End With

On Error GoTo ErrorHandler

‘ 1. StoryRangesコレクションの巡回(本文、ヘッダー、フッター、脚注、コメント等)
For Each rngStory In targetDoc.StoryRanges
Do
Call PerformReplaceOnRange(rngStory, findText, replaceText, lngCount)

‘ 連結されたサブストーリー(次ページのヘッダー等)が存在する場合の処理
Set rngStory = rngStory.NextStoryRange
Loop Until rngStory Is Nothing
Next rngStory

‘ 2. メインストーリーから漏れる「テキストボックス・図形内」の網羅的走査
For Each shp In targetDoc.Shapes
If shp.TextFrame.HasText Then
Call PerformReplaceOnRange(shp.TextFrame.TextRange, findText, replaceText, lngCount)
End If
‘ グループ化されたシェイプの再帰処理(必要に応じて展開)
If shp.Type = msoGroup Then
‘ ※必要に応じて再帰関数をコール
End If
Next shp

For Each inShp In targetDoc.InlineShapes
If inShp.TextFrame.HasText Then
Call PerformReplaceOnRange(inShp.TextFrame.TextRange, findText, replaceText, lngCount)
End If
Next inShp

‘ 正常終了ログ
Debug.Print “置換完了: 延べ ” & lngCount & ” 箇所を置換しました。”

CleanUp:
‘ 画面描画等の復元
With Application
.ScreenUpdating = True
.DisplayAlerts = wdAlertsAll
.Calculation = wdCalculationAutomatic
End With
Exit Sub

ErrorHandler:
MsgBox “致命的なエラーが発生しました: ” & Err.Description, vbCritical, “API Executor Error”
Resume CleanUp
End Sub

‘ =================================================================================
‘ 個別Rangeに対するFind/Replaceカプセル化メソッド
‘ =================================================================================
Private Sub PerformReplaceOnRange(ByVal rng As Range, _
ByVal findText As String, _
ByVal replaceText As String, _
ByRef totalCount As Long)

Dim wdFind As Find
Set wdFind = rng.Find

With wdFind
.ClearFormatting
.Replacement.ClearFormatting
.Text = findText
.Replacement.Text = replaceText
.Forward = True
.Wrap = wdFindStop ‘ ストーリー単位で完結させるため wdFindStop を指定
.Format = False
.MatchCase = False
.MatchWholeWord = False
.MatchWildcards = False
.MatchSoundsLike = False
.MatchAllWordForms = False

‘ 実行と置換数のカウント
If .Execute(Replace:=wdReplaceAll) Then
‘ wdReplaceAll の戻り値はBooleanだが、正確なカウントが必要な場合は
‘ ループ回すか、簡易的にフラグとして扱う
totalCount = totalCount + 1 ‘ ※厳密な置換回数は環境により調整
End If
End With

‘ COMオブジェクトの参照解放(メモリ最適化の極意)
Set wdFind = Nothing
End Sub

—

4. コードの深層解説:なぜこの実装なのか?

① `.Wrap = wdFindStop` の死守

複数ストーリーを巡回する場合、`wdFindContinue`(文書の最後まで行ったら先頭に戻る)を指定すると、同一のストーリー内で無限ループに陥るか、意図しない領域まで検索が侵食する。各ストーリーレンジは独立した閉じた空間であるため、`.Wrap = wdFindStop` を設定し、そのレンジ内を1回走査したら確実に抜ける設計にしなければならない。

② 明示的なメモリ解放(`Set … = Nothing`)

VBAのループ内でオブジェクト変数を使い回す際、ポインタの参照が残ったまま次のイテレーションに進むと、メモリリークの温床となる。特にWordの `Find` オブジェクトや `Range` オブジェクトは巨大なCOMラッパーを持つため、プロシージャの最後、あるいはループの節目で `Set wdFind = Nothing` を明示的に実行し、ガベージコレクションへ明確なシグナルを送る必要がある。

③ 描画エンジンの完全停止(`ScreenUpdating` と `Calculation`)

数万ワードに及ぶエンタープライズ文書や、数十個のコメント・脚注を含む文書において、GUIの再描画やフィールドの自動計算が有効なままだと、処理速度が何百倍も低下する。処理の冒頭で `ScreenUpdating = False` と `Calculation = wdCalculationManual` を強制し、CPUコアを文字列操作に100%集中させるのがプロフェッショナルの鉄則である。

—

5. チーフアーキテクトからの提言

システム開発において、Office VBAは「おもちゃのスクリプト言語」と侮られがちだ。しかし、巨大なレガシー文書の構造化、法務・金融分野における機密情報の網羅的置換、あるいは自動ドキュメント生成パイプラインの根幹において、Word VBAの挙動を深く理解しているか否かは、システムの信頼性を文字通り決定づける。

`StoryRanges` を制する者は、Word文書のあらゆるデータ構造を制する。
メモリのライフサイクルを意識し、隠されたテキストフレームやコメントの隅々にまで目を配る――それこそが、真にプロフェッショナルな業務自動化エンジニアのあり方である。

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