Word.TableOfContentsAddOptions interface
Word に追加するためのオプションを指定します。TableOfContentsCollection オブジェクト。
注釈
使用元
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/42-reference-tables/table-of-contents.yaml
// Adds a table of contents at the start of the document.
await Word.run(async (context) => {
const documentBody: Word.Body = context.document.body;
const tablesOfContents: Word.TableOfContentsCollection = context.document.tablesOfContents;
const insertionRange: Word.Range = documentBody.getRange(Word.RangeLocation.start);
const tableOptions: Word.TableOfContentsAddOptions = {
includePageNumbers: true,
lowerHeadingLevel: 2,
rightAlignPageNumbers: true,
upperHeadingLevel: 1,
useBuiltInHeadingStyles: true,
};
const tableOfContents: Word.TableOfContents = tablesOfContents.add(insertionRange, tableOptions);
await context.sync();
console.log("Created a table of contents.");
});
プロパティ
| added |
指定した場合は、目次に使用する追加スタイルの文字列名を指定します。 HeadingStyleCollection.add を使用して、新しい見出しスタイルを作成します。 |
| hide |
指定した場合は、Web に発行するときに目次のページ番号を非表示にするかどうかを指定します。 既定値は |
| include |
ページ番号を指定する場合は、目次にページ番号を含めるかどうかを指定します。 既定値は |
| lower |
指定する場合、目次の終了見出しレベルを指定します。1 から 9 までの値である必要があります。
|
| right |
指定する場合、目次のページ番号を右余白と揃えるかどうかを指定します。 既定値は |
| table |
指定した場合、目次に使用される TC フィールドから 1 文字の識別子を指定します。 目次 (TOC) フィールドの |
| upper |
指定する場合、目次の開始見出しレベルを指定し、1 から 9 の値にする必要があります。
|
| use |
指定された場合は、組み込みの見出しスタイルを使用して目次を作成するかどうかを指定します。 既定値は |
| use |
指定した場合は、目 次エントリ (TC) フィールド を使用して目次を作成するかどうかを指定します。
TableOfContentsCollection.markTocEntry メソッドを使用して、目次に含めるエントリをマークします。 既定値は |
| use |
ドキュメントを Web に発行するときに、目次のエントリをハイパーリンクとして書式設定するかどうかを指定します。 既定値は |
| use |
指定した場合は、アウトライン レベルを使用して目次を作成するかどうかを指定します。 既定値は |
プロパティの詳細
addedStyles
指定した場合は、目次に使用する追加スタイルの文字列名を指定します。 HeadingStyleCollection.add を使用して、新しい見出しスタイルを作成します。
addedStyles?: string;プロパティ値
string
注釈
hidePageNumbersOnWeb
指定した場合は、Web に発行するときに目次のページ番号を非表示にするかどうかを指定します。 既定値は true です。
hidePageNumbersOnWeb?: boolean;プロパティ値
boolean
注釈
includePageNumbers
ページ番号を指定する場合は、目次にページ番号を含めるかどうかを指定します。 既定値は true です。
includePageNumbers?: boolean;プロパティ値
boolean
注釈
lowerHeadingLevel
指定する場合、目次の終了見出しレベルを指定します。1 から 9 までの値である必要があります。
upperHeadingLevel
より大きい必要があります。 目次 (TOC) フィールドの\oスイッチで使用される終了値に対応します。 既定値は 9 です。
lowerHeadingLevel?: number;プロパティ値
number
注釈
rightAlignPageNumbers
指定する場合、目次のページ番号を右余白と揃えるかどうかを指定します。 既定値は true です。
rightAlignPageNumbers?: boolean;プロパティ値
boolean
注釈
tableId
指定した場合、目次に使用される TC フィールドから 1 文字の識別子を指定します。 目次 (TOC) フィールドの\fスイッチに対応します。 たとえば、"T" は、目にテーブル識別子 T を使用する TC フィールドが含まれていることを示します。この引数を省略した場合、TC フィールドは使用されません。
tableId?: string;プロパティ値
string
注釈
upperHeadingLevel
指定する場合、目次の開始見出しレベルを指定し、1 から 9 の値にする必要があります。
lowerHeadingLevel
より小さくする必要があります。 目次 (TOC) フィールドの\oスイッチで使用される開始値に対応します。 既定値は 1 です。
upperHeadingLevel?: number;プロパティ値
number
注釈
useBuiltInHeadingStyles
指定された場合は、組み込みの見出しスタイルを使用して目次を作成するかどうかを指定します。 既定値は true です。
useBuiltInHeadingStyles?: boolean;プロパティ値
boolean
注釈
useFields
指定した場合は、目 次エントリ (TC) フィールド を使用して目次を作成するかどうかを指定します。
TableOfContentsCollection.markTocEntry メソッドを使用して、目次に含めるエントリをマークします。 既定値は false です。
useFields?: boolean;プロパティ値
boolean
注釈
useHyperlinksOnWeb
ドキュメントを Web に発行するときに、目次のエントリをハイパーリンクとして書式設定するかどうかを指定します。 既定値は true です。
useHyperlinksOnWeb?: boolean;プロパティ値
boolean
注釈
useOutlineLevels
指定した場合は、アウトライン レベルを使用して目次を作成するかどうかを指定します。 既定値は false です。
useOutlineLevels?: boolean;プロパティ値
boolean