Word.TableOfContentsMarkEntryOptions interface

Pacote:
word

Especifica as opções para inserir um campo TC (Entrada de Sumário).

Comentários

Conjunto de APIs: WordApiDesktop 1.4

Usada por

Exemplos

// 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.`);
});

Propriedades

entry

Se fornecido, especifica o texto que aparece em um sumário ou em um sumário de ilustrações. Para indicar uma subentrada, inclua o texto da entrada principal e o texto da subentrada, separados por dois pontos (":") (por exemplo, "Introdução: O Produto"). Quando a entryAutoText propriedade estiver definida, ela será ignorada.
entryAutoText

Se fornecido, especifica o nome da entrada de AutoTexto que inclui texto para o sumário ou sumário. Quando essa propriedade é usada, a entry propriedade é ignorada.
level

Se fornecido, especifica o nível para a entrada em um sumário ou índice de ilustrações e deve ser um valor de 1 a 9.
tableId

Se fornecido, especifica um identificador de uma letra para um sumário ou índice de figuras (por exemplo, "i" para uma "ilustração").

Detalhes da propriedade

entry

Se fornecido, especifica o texto que aparece em um sumário ou em um sumário de ilustrações. Para indicar uma subentrada, inclua o texto da entrada principal e o texto da subentrada, separados por dois pontos (":") (por exemplo, "Introdução: O Produto"). Quando a entryAutoText propriedade estiver definida, ela será ignorada.

entry?: string;

Valor da propriedade

string

Comentários

Conjunto de APIs: WordApiDesktop 1.4

entryAutoText

Se fornecido, especifica o nome da entrada de AutoTexto que inclui texto para o sumário ou sumário. Quando essa propriedade é usada, a entry propriedade é ignorada.

entryAutoText?: string;

Valor da propriedade

string

Comentários

Conjunto de APIs: WordApiDesktop 1.4

level

Se fornecido, especifica o nível para a entrada em um sumário ou índice de ilustrações e deve ser um valor de 1 a 9.

level?: number;

Valor da propriedade

number

Comentários

Conjunto de APIs: WordApiDesktop 1.4

tableId

Se fornecido, especifica um identificador de uma letra para um sumário ou índice de figuras (por exemplo, "i" para uma "ilustração").

tableId?: string;

Valor da propriedade

string

Comentários

Conjunto de APIs: WordApiDesktop 1.4