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