Word.TableOfContentsMarkEntryOptions interface

Пакет:

word

Определяет параметры для вставки поля "Элемент оглавления".

Комментарии

Набор API: WordApiDesktop 1.4

Используется

• Word. TableOfContentsCollection: markTocEntry
• Word. TableOfFiguresCollection: markTocEntry

Примеры

// 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	Если дано, определяет текст, отображаемый в оглавлении или оглавлении иллюстраций. Чтобы указать вложенный элемент, включите основной и вложенный тексты, разделенные двоеточием (":") (например, "Введение:Продукт"). Когда свойство entryAutoText задано, это свойство игнорируется.
entryAutoText	Если параметр указан, указывает имя элемента автотекста, содержащего текст для оглавления или оглавления. При использовании entry этого свойства оно игнорируется.
level	Определяет уровень элемента в оглавлении или таблице иллюстраций, если указан. Значение должно составлять от 1 до 9.
tableId	Определяет однобуквенный идентификатор для оглавления или оглавления рисунков (например, "i" для "иллюстрации").

Сведения о свойстве

entry

Если дано, определяет текст, отображаемый в оглавлении или оглавлении иллюстраций. Чтобы указать вложенный элемент, включите основной и вложенный тексты, разделенные двоеточием (":") (например, "Введение:Продукт"). Когда свойство entryAutoText задано, это свойство игнорируется.

entry?: string;

Значение свойства

string

Комментарии

Набор API: WordApiDesktop 1.4

entryAutoText

Если параметр указан, указывает имя элемента автотекста, содержащего текст для оглавления или оглавления. При использовании entry этого свойства оно игнорируется.

entryAutoText?: string;

Значение свойства

string

Комментарии

Набор API: WordApiDesktop 1.4

level

Определяет уровень элемента в оглавлении или таблице иллюстраций, если указан. Значение должно составлять от 1 до 9.

level?: number;

Значение свойства

number

Комментарии

Набор API: WordApiDesktop 1.4

tableId

Определяет однобуквенный идентификатор для оглавления или оглавления рисунков (например, "i" для "иллюстрации").

tableId?: string;

Значение свойства

string

Комментарии

Набор API: WordApiDesktop 1.4