目次の操作
多くの場合、目次(TOC)を含む文書を操作します。 Aspose.Wordsを使用すると、数行のコードを使用して、独自の目次を挿入したり、ドキュメント内の既存の目次を完全に再構築したりできます。Aspose.Wordsを使用すると、独自の目次を挿入することができます。
この記事では、目次フィールドを操作する方法の概要と、次のことを示します:
- 新しいTOCを挿入する方法。
- 文書内の新規または既存のTOCsを更新します。
- TOCの書式設定と全体的な構造を制御するスイッチを指定します。
- 目次のスタイルと外観を変更する方法。
- 文書からすべてのエントリとともに
TOCフィールド全体を削除する方法。
プログラムで目次を挿入する
InsertTableOfContentsメソッドを呼び出すことで、現在の位置にある文書にTOC(目次)フィールドを挿入できます。
Word文書の目次は、いくつかの方法で構築し、さまざまなオプションを使用してフォーマットすることができます。 メソッドに渡すフィールドスイッチは、テーブルの作成方法とドキュメント内での表示方法を制御します。
Microsoft Wordに挿入されたTOCで使用されるデフォルトのスイッチは**"\o “1-3 \h \z \u”**です。 これらのスイッチの説明とサポートされているスイッチのリストは、記事の後半で見つけることができます。 そのガイドを使用して正しいスイッチを取得するか、必要な同様のTOCを含むドキュメントが既にある場合は、フィールドコード（*ALT+F9*）を表示して、フィールドか
次のコード例は、目次フィールドをドキュメントに挿入する方法を示しています:
次のコード例は、見出しスタイルをエントリとして使用して目次(TOC)をドキュメントに挿入する方法を示しています:
このコードは、新しい目次が空白の文書に挿入されていることを示しています。 次に、DocumentBuilderクラスを使用して、TOCに含まれるコンテンツをマークするために使用される適切な見出しスタイルを持つサンプルコンテンツの書式設定を挿入します。 次の行は、文書のフィールドとページレイアウトを更新してTOCに入力します。
TOCフィールドが見つかりますが、表示されているコンテンツはありません。 これは、TOCフィールドが挿入されていますが、ドキュメントで更新されるまでまだ入力されていないためです。 これに関する詳細については、次のセクションで説明します。
目次の更新
Aspose.Wordsを使用すると、数行のコードだけでTOCを完全に更新できます。 これは、新しく挿入されたTOCを入力するか、文書への変更が行われた後に既存のTOCを更新するために行うことができます。
ドキュメント内のTOCフィールドを更新するには、次の2つの方法を使用する必要があります:
これらの2つのupdateメソッドは、この順序で呼び出される必要があることに注意してください。 逆にすると、目次が入力されますが、ページ番号は表示されません。 任意の数の異なるTOCsを更新できます。 これらのメソッドは、ドキュメント内のすべてのTOCsを自動的に更新します。
次のコード例は、フィールドの更新を呼び出して、ドキュメント内のTOCフィールドを完全に再構築する方法を示しています:
Document.updateFields()への最初の呼び出しはTOCを構築し、すべてのテキストエントリが入力され、TOCはほぼ完了しているように見えます。 欠けているのは、今のところ"?“で表示されているページ番号だけです。
Document.updatePageLayout()への2番目の呼び出しは、メモリ内のドキュメントのレイアウトを構築します。 これは、エントリのページ番号を収集するために行う必要があります。 この呼び出しから計算された正しいページ番号がTOCに挿入されます。
スイッチを使用して目次の動作を制御する
他のフィールドと同様に、TOCフィールドは、目次の構築方法を制御するフィールドコード内で定義されたスイッチを受け入れることができます。 特定のスイッチは、どのエントリが含まれ、どのレベルで制御されるかを制御するために使用され、他のスイッチはTOCの外観を制御するために使 スイッチは複雑な目次が作り出されるように一緒に結合することができる。
デフォルトでは、ドキュメントにデフォルトのTOCを挿入するときに、上記のこれらのスイッチが含まれます。 スイッチのないTOCには、組み込みの見出しスタイルのコンテンツが含まれます（\Oスイッチが設定されているかのように）。
Aspose.Wordsでサポートされている利用可能なTOCスイッチを以下に示し、その用途について詳しく説明します。 それらはそれらのタイプに基づいて別々のセクションに分けることができます。 最初のセクションのスイッチはTOCに含めるコンテンツを定義し、2番目のセクションのスイッチはTOCの外観を制御します。
スイッチがここにリストされていない場合は、現在サポートされていません。 すべてのスイッチは将来のバージョンでサポートされます。 私たちは、すべてのリリースにさらにサポートを追加しています。
エントリーマーキングスイッチ
| スイッチ | 説明 |
|---|---|
| Heading Styles (\Oスイッチ) |
このスイッチは、
|
| Outline Levels (\Uスイッチ) |
各段落は、段落オプションの下でアウトラインレベルを定義できます。
Heading 1などの組み込みの見出しスタイルには、スタイル設定でアウトラインレベルが必須に設定されていることに注意してください。
|
| Custom Styles (\Tスイッチ) |
このスイッチを使用すると、TOCで使用するエントリを収集するときにカスタムスタイルを使用できます。 これは、TOCに組み込みの見出しスタイルとともにカスタムスタイルを含めるために、\Oスイッチと組み合わせて使用されることがよくあります。
|
| TCフィールドを使用する (\Fおよび\Lスイッチ) |
古いバージョンのMicrosoft Wordでは、
これらのフィールドは、他のフィールドと同様に任意の位置にドキュメントに挿入でき、 次のようなTCフィールドのみが含まれます
-\F-上記で説明しました。 -\L-このTCフィールドが表示される - |
外観関連スイッチ
| スイッチ | 説明 |
|---|---|
| Omit Page Numbers (\Nスイッチ) |
このスイッチは、TOCの特定のレベルのページ番号を非表示にするために使用されます。 たとえば、次のように定義できます そして、レベル3と4のエントリのページ番号は、リーダードット（もしあれば）と一緒に隠されます。 たとえば、“1-1"では、最初のレベルのページ番号のみが除外されます。
|
| ハイパーリンクとして挿入 (\Hスイッチ) |
このスイッチは
|
| Set Separator Character (\Pスイッチ) |
このスイッチを使用すると、エントリのタイトルとページ番号を分離するコンテンツをTOCで簡単に変更できます。 使用する区切り文字は、このスイッチの後に指定し、音声マークで囲む必要があります。
|
| Preserve Tab Entries (\Wスイッチ) |
このスイッチを使用すると、タブ文字を持つエントリ、たとえば行末にタブがある見出しは、TOCを入力するときに適切なタブ文字として保持されます。 これは、タブ文字の機能が
|
| Preserve New Line Entries (\Xスイッチ) |
上記のスイッチと同様に、このスイッチは、生成されたTOCにあるように、複数の行にまたがる見出し（段落を分離するのではなく改行文字を使用）を保 たとえば、複数の行にまたがる見出しでは、改行文字(Ctrl+Enterまたは
|
TCフィールドを挿入します
新しいTCフィールドをDocumentBuilderの現在位置に挿入するには、DocumentBuilder.InsertFieldメソッドを呼び出し、必要なスイッチとともにフィールド名を"TC"として指定します。
次のコード例は、DocumentBuilderを使用して文書にTCフィールドを挿入する方法を示しています。
多くの場合、特定のテキスト行がTOCに指定され、TCフィールドでマークされます。 MSWordでこれを行う簡単な方法は、テキストを強調表示してALT+SHIFT+Oを押すことです。 これにより、選択したテキストを使用してTCフィールドが自動的に作成されます。 同じ手法は、コードを介して達成することができます。 以下のコードは、入力に一致するテキストを検索し、テキストと同じ位置にTCフィールドを挿入します。 このコードは、記事で使用されているのと同じ手法に基づいています。 次のコード例は、ドキュメント内のテキストにTCフィールドを検索して挿入する方法を示しています。
目次を変更する
スタイルの書式設定を変更する
TOC内のエントリの書式は、マークされたエントリの元のスタイルを使用せず、代わりに各レベルは同等のTOCスタイルを使用して書式設定されます。 たとえば、TOCの最初のレベルはTOC1スタイルで書式設定され、2番目のレベルはTOC2スタイルで書式設定されます。 これは、TOCの外観を変更するには、これらのスタイルを変更する必要があることを意味します。 Aspose.Wordsでは、これらのスタイルはロケールに依存しないStyleIdentifier.TOC1からStyleIdentifier.TOC9までで表され、これらの識別子を使用してDocument.Stylesコレクションから取得できます。Aspose.Wordsでは、ロケールに依存しないStyleIdentifier.TOC1からStyleIdentifier.TOC9までのスタイルが表されます。
文書の適切なスタイルが取得されたら、このスタイルの書式を変更することができます。 これらのスタイルへの変更は、文書内のTOCsに自動的に反映されます。
次のコード例では、最初のレベルTOCスタイルで使用される書式設定プロパティを変更します。
また、TOCに含まれるようにマークされた段落（スタイルではなく段落自体で定義されている）の直接の書式設定は、TOCのエントリにコピーされることに注意 たとえば、Heading 1スタイルを使用してTOCのコンテンツをマークし、このスタイルには太字の書式があり、段落には斜体の書式が直接適用されている場合です。 結果のTOCエントリはスタイルの書式設定の一部であるため太字ではありませんが、段落で直接書式設定されているため斜体になります。
また、各エントリとページ番号の間で使用される区切り文字の書式設定を制御することもできます。 デフォルトでは、これはタブ文字を使用してページ番号に広がる点線であり、右マージンの近くに並んでいる右タブストップがあります。
変更する特定のTOCレベルに対して取得されたStyleクラスを使用して、これらが文書内でどのように表示されるかを変更することもできます。
これが最初にどのように表示されるかを変更するには、スタイルの段落書式を取得するためにStyle.ParagraphFormatを呼び出す必要があります。 これにより、タブストップはParagraphFormat.TabStopsを呼び出し、適切なタブストップを変更することによって取得できます。 この同じ手法を使用して、タブ自体を移動または完全に削除することができます。
次のコード例は、TOC関連する段落の右タブストップの位置を変更する方法を示しています。
ドキュメントから目次を削除する
目次は、TOCフィールドのFieldStartノードとFieldEndノードの間にあるすべてのノードを削除することによって、ドキュメントから削除できます。
以下のコードはこれを示しています。 TOCフィールドの削除は、ネストされたフィールドを追跡しないため、通常のフィールドよりも簡単です。 代わりに、現在のTOCの終わりに遭遇したことを意味するFieldEndノードのタイプがFieldType.FieldTOCであることを確認します。 この場合、適切に形成された文書は別のTOCフィールド内に完全にネストされたTOCフィールドを持たないと仮定できるので、ネストされたフィールドを気にせずにこの手法を使用することができます。
まず、各TOCのFieldStartノードが収集され、格納されます。 次に、指定されたTOCが列挙され、フィールド内のすべてのノードが訪問されて格納されます。 その後、ノードはドキュメントから削除されます。 次のコード例は、指定されたTOCをドキュメントから削除する方法を示しています。
目次を抽出する
Word文書から目次を抽出する場合は、次のコードサンプルを使用できます。