Word.TableOfContentsMarkEntryOptions interface

Package:
word

Spécifie les options d’insertion d’un champ d’entrée de table des matières.

Remarques

Jeu d’API : WordApiDesktop 1.4

Utilisateur

Exemples

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

Propriétés

entry

S’il est fourni, spécifie le texte qui apparaît dans une table des matières ou une table des figures. Pour indiquer une sous-entrée, incluez le texte de l’entrée principale et le texte de la sous-entrée, séparés par un signe deux-points (« : ») (par exemple, « Introduction : Le produit »). Lorsque la entryAutoText propriété est définie, celle-ci est ignorée.
entryAutoText

S’il est fourni, spécifie le nom de l’entrée d’insertion automatique qui inclut du texte pour la table des figures ou la table des matières. Lorsque cette propriété est utilisée, elle entry est ignorée.
level

S’il est fourni, il spécifie le niveau de l’entrée dans une table des matières ou une table des illustrations et doit être compris entre 1 et 9.
tableId

Le cas échéant, spécifie un identificateur à une lettre pour une table des matières ou une table des illustrations (par exemple, « i » pour une « illustration »).

Détails de la propriété

entry

S’il est fourni, spécifie le texte qui apparaît dans une table des matières ou une table des figures. Pour indiquer une sous-entrée, incluez le texte de l’entrée principale et le texte de la sous-entrée, séparés par un signe deux-points (« : ») (par exemple, « Introduction : Le produit »). Lorsque la entryAutoText propriété est définie, celle-ci est ignorée.

entry?: string;

Valeur de propriété

string

Remarques

Jeu d’API : WordApiDesktop 1.4

entryAutoText

S’il est fourni, spécifie le nom de l’entrée d’insertion automatique qui inclut du texte pour la table des figures ou la table des matières. Lorsque cette propriété est utilisée, elle entry est ignorée.

entryAutoText?: string;

Valeur de propriété

string

Remarques

Jeu d’API : WordApiDesktop 1.4

level

S’il est fourni, il spécifie le niveau de l’entrée dans une table des matières ou une table des illustrations et doit être compris entre 1 et 9.

level?: number;

Valeur de propriété

number

Remarques

Jeu d’API : WordApiDesktop 1.4

tableId

Le cas échéant, spécifie un identificateur à une lettre pour une table des matières ou une table des illustrations (par exemple, « i » pour une « illustration »).

tableId?: string;

Valeur de propriété

string

Remarques

Jeu d’API : WordApiDesktop 1.4