このトピックでは、Word ドキュメントの目次オブジェクトに関連する API 操作について説明します。
目次
ActiveDocument.TablesOfContents
アクティブなドキュメント内のすべての目次を返します。
JavaScript V1.1.12 以降の SDK のみでこの機能がサポートされています。
この機能は PC のみに適用されます。
構文
expression.ActiveDocument.TablesOfContents
expression: アプリケーション オブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // アクティブなドキュメント内のすべての目次を取得します。 const tablesOfContents = await app.ActiveDocument.TablesOfContents; }
メソッド
ActiveDocument.TablesOfContents.Add()
目次を追加します。
JavaScript V1.1.12 以降の SDK のみでこの機能がサポートされています。
この機能は PC のみに適用されます。
構文
expression.ActiveDocument.TablesOfContents.Add({ Range })
expression: アプリケーション オブジェクト。
パラメーター
パラメーター
タイプ
必須
説明
Range
オブジェクト
はい
目次を追加する範囲。範囲を指定するには、次のパラメーターを設定します。
Start: 目次の開始位置。値のタイプは数値です。
Start: 目次の終了位置。値のタイプは数値です。
例
async function example() { await instance.ready(); const app = instance.Application; // Range オブジェクトを取得します。 const range = await app.ActiveDocument.Range(0, 0); // 目次を追加します。 await app.ActiveDocument.TablesOfContents.Add(range); }
プロパティ
ActiveDocument.TablesOfContents.Count
指定されたドキュメント内の目次の総数を照会します。
JavaScript V1.1.12 以降の SDK のみでこの機能がサポートされています。
この機能は PC のみに適用されます。
構文
expression.ActiveDocument.TablesOfContents.Count
expression: アプリケーション オブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // Range オブジェクトを取得します。 const range = await app.ActiveDocument.Range(0, 0); // 目次を追加します。 await app.ActiveDocument.TablesOfContents.Add(range); // ドキュメント内の目次の数を取得します。 await app.ActiveDocument.TablesOfContents.Count; }
目次
ActiveDocument.TablesOfContents.Item()
アクティブなドキュメント内の単一の目次を返します。
TableOfContents
オブジェクトとTablesOfContents
オブジェクトは異なります。前者は単一の目次を表し、後者はドキュメント内の目次のコレクションを表します。1 つのドキュメントに複数の目次を含めることができます。JavaScript V1.1.12 以降の SDK のみでこの機能がサポートされています。
この機能は PC のみに適用されます。
構文
expression.ActiveDocument.TablesOfContents.Item(Index)
expression: アプリケーション オブジェクト。
パラメーター
プロパティ
タイプ
必須
説明
Index
数値
はい
目次のインデックス。
例
async function example() { await instance.ready(); const app = instance.Application; // Range オブジェクトを取得します。 const range = await app.ActiveDocument.Range(0, 0); // 目次を追加します。 await app.ActiveDocument.TablesOfContents.Add(range); // 単一の目次を取得します。 await app.ActiveDocument.TablesOfContents.Item(1); }
メソッド
ActiveDocument.TablesOfContents.Item(Index).Update()
目次全体を更新します。
JavaScript V1.1.12 以降の SDK のみでこの機能がサポートされています。
この機能は PC のみに適用されます。
構文
expression.ActiveDocument.TablesOfContents.Item(Index).Update()
expression: アプリケーション オブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // Range オブジェクトを取得します。 const range = await app.ActiveDocument.Range(0, 0); // 目次を追加します。 await app.ActiveDocument.TablesOfContents.Add(range); // 目次全体を更新します。 await app.ActiveDocument.TablesOfContents.Item(1).Update(); }
ActiveDocument.TablesOfContents.Item(Index).UpdatePageNumbers()
指定された目次内の項目のページ番号を更新します。
JavaScript V1.1.12 以降の SDK のみでこの機能がサポートされています。
この機能は PC のみに適用されます。
構文
expression.ActiveDocument.TablesOfContents.Item(Index).UpdatePageNumbers()
expression: アプリケーション オブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // Range オブジェクトを取得します。 const range = await app.ActiveDocument.Range(0, 0); // 目次を追加します。 await app.ActiveDocument.TablesOfContents.Add(range); // 目次内の項目のページ番号のみを更新します。 await app.ActiveDocument.TablesOfContents.Item(1).UpdatePageNumbers(); }
ActiveDocument.TablesOfContents.Item(Index).SetStyles()
指定された目次のスタイルを設定します。
JavaScript V1.1.12 以降の SDK のみでこの機能がサポートされています。
この機能は PC のみに適用されます。
構文
expression.ActiveDocument.TablesOfContents.Item(Index).SetStyles(LowerHeadingLevel, IncludePageNumbers, TabLeader)
expression: アプリケーション オブジェクト。
パラメーター
プロパティ
タイプ
必須
説明
LowerHeadingLevel
数値
いいえ
目次の終了見出しレベル。有効な値の範囲は 1 ~ 9 です。
IncludePageNumbers
ブール値
いいえ
目次に見出しレベルを含めるかどうかを指定します。有効な値:
true (デフォルト)
false
TabLeader
数値
いいえ
目次のエントリとそれに関連付けられたページ番号の間のリーダー文字。詳細については、「WdTabLeader」をご参照ください。
例
async function example() { await instance.ready(); const app = instance.Application; // Range オブジェクトを取得します。 const range = await app.ActiveDocument.Range(0, 0); // 目次を追加します。 await app.ActiveDocument.TablesOfContents.Add(range); // 目次のスタイルを設定します。 const tabLeader = app.Enum.WdTabLeader.wdTabLeaderDashes await app.ActiveDocument.TablesOfContents.Item(1).SetStyles(9, true, tabLeader) }
ActiveDocument.TablesOfContents.Item(Index).Delete()
指定された目次を削除します。
JavaScript V1.1.12 以降の SDK のみでこの機能がサポートされています。
この機能は PC のみに適用されます。
構文
expression.ActiveDocument.TablesOfContents.Item(Index).Delete()
expression: アプリケーション オブジェクト。
例
async function example() { await instance.ready(); const app = instance.Application; // Range オブジェクトを取得します。 const range = await app.ActiveDocument.Range(0, 0); // 目次を追加します。 await app.ActiveDocument.TablesOfContents.Add(range); // 目次を削除します。 await app.ActiveDocument.TablesOfContents.Item(1).Delete(); }