Word.TableOfContentsMarkEntryOptions interface
目次エントリ (TC) フィールドを挿入するためのオプションを指定します。
注釈
使用元
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/42-reference-tables/table-of-figures.yaml
// Marks each figure paragraph as a table entry.
await Word.run(async (context) => {
const documentBody: Word.Body = context.document.body;
const tablesOfFigures: Word.TableOfFiguresCollection = context.document.tablesOfFigures;
const paragraphs: Word.ParagraphCollection = documentBody.paragraphs;
paragraphs.load("items/text");
await context.sync();
const figureParagraphs: Word.Paragraph[] = paragraphs.items.filter((paragraph: Word.Paragraph) =>
paragraph.text.startsWith("Figure ")
);
figureParagraphs.forEach((figureParagraph: Word.Paragraph) => {
const entryOptions: Word.TableOfContentsMarkEntryOptions = {
entry: figureParagraph.text,
level: 1,
tableId: "F",
};
const entryRange: Word.Range = figureParagraph.getRange();
tablesOfFigures.markTocEntry(entryRange, entryOptions);
});
await context.sync();
console.log(`Marked ${figureParagraphs.length} table of figures entries.`);
});
プロパティ
| entry | 指定した場合、目次または図表に表示されるテキストを指定します。 サブエントリを示すには、メイン エントリ テキストとサブエントリ テキストをコロン (":") で区切って含めます (例: "Introduction:The Product")。
|
| entry |
指定した場合は、図表または目次のテキストを含む定型句エントリ名を指定します。 このプロパティを使用すると、 |
| level | 指定する場合、目次または数字のテーブル内のエントリのレベルを指定します。値は 1 から 9 までです。 |
| table |
指定する場合は、目次または図次の 1 文字の識別子を指定します (例: "図" の場合は "i")。 |
プロパティの詳細
entry
指定した場合、目次または図表に表示されるテキストを指定します。 サブエントリを示すには、メイン エントリ テキストとサブエントリ テキストをコロン (":") で区切って含めます (例: "Introduction:The Product")。
entryAutoText プロパティが設定されている場合、このプロパティは無視されます。
entry?: string;プロパティ値
string
注釈
entryAutoText
指定した場合は、図表または目次のテキストを含む定型句エントリ名を指定します。 このプロパティを使用すると、 entry プロパティは無視されます。
entryAutoText?: string;プロパティ値
string
注釈
level
指定する場合、目次または数字のテーブル内のエントリのレベルを指定します。値は 1 から 9 までです。
level?: number;プロパティ値
number
注釈
tableId
指定する場合は、目次または図次の 1 文字の識別子を指定します (例: "図" の場合は "i")。
tableId?: string;プロパティ値
string