Word.TableOfContentsMarkEntryOptions interface

Paket:
word

Gibt die Optionen zum Einfügen eines Inhaltsverzeichniseintragsfelds an.

Hinweise

API-Satz: WordApiDesktop 1.4

Verwendet von

Beispiele

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

Eigenschaften

entry

Gibt (sofern angegeben) den Text an, der in einem Inhaltsverzeichnis oder Abbildungsverzeichnis enthalten ist. Um einen Untereintrag zu kennzeichnen, geben Sie den Haupteintragstext und den Untereintragstext an, getrennt durch einen Doppelpunkt (":") (z. B. "Einleitung:Das Produkt"). Wenn die entryAutoText Eigenschaft festgelegt ist, wird diese Eigenschaft ignoriert.
entryAutoText

Gibt (sofern angegeben) den Namen des AutoText-Eintrags an, der Text für das Abbildungs- oder Inhaltsverzeichnis enthält. Wenn diese Eigenschaft verwendet wird, wird die entry Eigenschaft ignoriert.
level

Gibt (sofern angegeben) die Ebene für den Eintrag in einem Inhaltsverzeichnis oder Abbildungsverzeichnis an und sollte einen Wert zwischen 1 und 9 aufweisen.
tableId

Gibt (sofern angegeben) einen Ein-Buchstaben-Bezeichner für ein Inhaltsverzeichnis oder ein Abbildungsverzeichnis an (z. B. "i" für eine "Abbildung").

Details zur Eigenschaft

entry

Gibt (sofern angegeben) den Text an, der in einem Inhaltsverzeichnis oder Abbildungsverzeichnis enthalten ist. Um einen Untereintrag zu kennzeichnen, geben Sie den Haupteintragstext und den Untereintragstext an, getrennt durch einen Doppelpunkt (":") (z. B. "Einleitung:Das Produkt"). Wenn die entryAutoText Eigenschaft festgelegt ist, wird diese Eigenschaft ignoriert.

entry?: string;

Eigenschaftswert

string

Hinweise

API-Satz: WordApiDesktop 1.4

entryAutoText

Gibt (sofern angegeben) den Namen des AutoText-Eintrags an, der Text für das Abbildungs- oder Inhaltsverzeichnis enthält. Wenn diese Eigenschaft verwendet wird, wird die entry Eigenschaft ignoriert.

entryAutoText?: string;

Eigenschaftswert

string

Hinweise

API-Satz: WordApiDesktop 1.4

level

Gibt (sofern angegeben) die Ebene für den Eintrag in einem Inhaltsverzeichnis oder Abbildungsverzeichnis an und sollte einen Wert zwischen 1 und 9 aufweisen.

level?: number;

Eigenschaftswert

number

Hinweise

API-Satz: WordApiDesktop 1.4

tableId

Gibt (sofern angegeben) einen Ein-Buchstaben-Bezeichner für ein Inhaltsverzeichnis oder ein Abbildungsverzeichnis an (z. B. "i" für eine "Abbildung").

tableId?: string;

Eigenschaftswert

string

Hinweise

API-Satz: WordApiDesktop 1.4