Word.TableOfFiguresAddOptions interface

Word に追加するためのオプションを指定します。TableOfFiguresCollection オブジェクト。

プロパティ

addedStyles

指定した場合は、図表に使用する追加スタイルの文字列名を指定します。

captionLabel

指定した場合は、図表に含める項目を識別するラベルを指定します。 目次 (TOC) フィールド\cスイッチに対応します。 既定値は "Figure" です。

hidePageNumbersOnWeb

指定した場合は、Web に発行するときに図表のページ番号を非表示にするかどうかを指定します。 既定値は true です。

includeLabel

指定した場合は、図表にキャプション ラベルとキャプション番号を含めるかどうかを指定します。 既定値は true です。

includePageNumbers

ページ番号を図表に含めるかどうかを指定します (指定する場合)。 既定値は true です。

lowerHeadingLevel

指定した場合、 useBuiltInHeadingStylestrue に設定されている場合の図表の終了見出しレベルを指定します。 1 から 9 までの値で、 upperHeadingLevel より大きい必要があります。 目次 (TOC) フィールド\oスイッチで使用される終了値に対応します。 既定値は 9 です。

rightAlignPageNumbers

指定された場合、図表の右余白にページ番号を合わせるかどうかを指定します。 既定値は true です。

tableId

指定した場合は、図表に使用される TC フィールド からの 1 文字の識別子を指定します。 目次 (TOC) フィールド\fスイッチに対応します。 たとえば、"T" は、テーブル識別子 T を使用する TC フィールドがテーブルに含まれている図テーブルを示します。

upperHeadingLevel

指定した場合は、 useBuiltInHeadingStylestrue に設定されている場合の図表の開始見出しレベルを指定します。 1 から 9 までの値で、 lowerHeadingLevel より小さい必要があります。 目次 (TOC) フィールド\oスイッチで使用される開始値に対応します。 既定値は 1 です。

useBuiltInHeadingStyles

指定された場合は、組み込みの見出しスタイルを使用して図表を作成するかどうかを指定します。 既定値は false です。

useFields

指定した場合、目 次エントリ (TC) フィールド を使用して図表を作成するかどうかを指定します。 TableOfFiguresCollection.markTocEntry メソッドを使用して、図表に含めるエントリをマークします。 既定値は false です。

useHyperlinksOnWeb

ドキュメントを Web に発行するときに、図表のエントリをハイパーリンクとして書式設定するかどうかを指定します。 既定値は true です。

プロパティの詳細

addedStyles

指定した場合は、図表に使用する追加スタイルの文字列名を指定します。

addedStyles?: string;

プロパティ値

string

注釈

API セット: WordApiDesktop 1.4

captionLabel

指定した場合は、図表に含める項目を識別するラベルを指定します。 目次 (TOC) フィールド\cスイッチに対応します。 既定値は "Figure" です。

captionLabel?: string;

プロパティ値

string

注釈

API セット: WordApiDesktop 1.4

hidePageNumbersOnWeb

指定した場合は、Web に発行するときに図表のページ番号を非表示にするかどうかを指定します。 既定値は true です。

hidePageNumbersOnWeb?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

includeLabel

指定した場合は、図表にキャプション ラベルとキャプション番号を含めるかどうかを指定します。 既定値は true です。

includeLabel?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

includePageNumbers

ページ番号を図表に含めるかどうかを指定します (指定する場合)。 既定値は true です。

includePageNumbers?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

lowerHeadingLevel

指定した場合、 useBuiltInHeadingStylestrue に設定されている場合の図表の終了見出しレベルを指定します。 1 から 9 までの値で、 upperHeadingLevel より大きい必要があります。 目次 (TOC) フィールド\oスイッチで使用される終了値に対応します。 既定値は 9 です。

lowerHeadingLevel?: number;

プロパティ値

number

注釈

API セット: WordApiDesktop 1.4

rightAlignPageNumbers

指定された場合、図表の右余白にページ番号を合わせるかどうかを指定します。 既定値は true です。

rightAlignPageNumbers?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

tableId

指定した場合は、図表に使用される TC フィールド からの 1 文字の識別子を指定します。 目次 (TOC) フィールド\fスイッチに対応します。 たとえば、"T" は、テーブル識別子 T を使用する TC フィールドがテーブルに含まれている図テーブルを示します。

tableId?: string;

プロパティ値

string

注釈

API セット: WordApiDesktop 1.4

upperHeadingLevel

指定した場合は、 useBuiltInHeadingStylestrue に設定されている場合の図表の開始見出しレベルを指定します。 1 から 9 までの値で、 lowerHeadingLevel より小さい必要があります。 目次 (TOC) フィールド\oスイッチで使用される開始値に対応します。 既定値は 1 です。

upperHeadingLevel?: number;

プロパティ値

number

注釈

API セット: WordApiDesktop 1.4

useBuiltInHeadingStyles

指定された場合は、組み込みの見出しスタイルを使用して図表を作成するかどうかを指定します。 既定値は false です。

useBuiltInHeadingStyles?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

useFields

指定した場合、目 次エントリ (TC) フィールド を使用して図表を作成するかどうかを指定します。 TableOfFiguresCollection.markTocEntry メソッドを使用して、図表に含めるエントリをマークします。 既定値は false です。

useFields?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4

useHyperlinksOnWeb

ドキュメントを Web に発行するときに、図表のエントリをハイパーリンクとして書式設定するかどうかを指定します。 既定値は true です。

useHyperlinksOnWeb?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.4