Word.TableOfContents class

Ruft die zusätzlichen Formatvorlagen ab, die für das Inhaltsverzeichnis verwendet werden. Die Standardformatvorlagen "Überschrift 1" – "Überschrift 9" sind in dieser Auflistung nicht enthalten.

readonly additionalHeadingStyles: Word.HeadingStyleCollection;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Gibt an, ob integrierte Überschriftenformatvorlagen für das Inhaltsverzeichnis verwendet werden.

areBuiltInHeadingStylesUsed: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Gibt an, ob Tc-Felder (Table of Contents Entry) im Inhaltsverzeichnis enthalten sind.

areFieldsUsed: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Gibt an, ob Einträge im Inhaltsverzeichnis beim Veröffentlichen im Web als Hyperlinks formatiert werden sollen.

areHyperlinksUsedOnWeb: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Gibt an, ob die Seitenzahlen im Inhaltsverzeichnis bei der Veröffentlichung im Web ausgeblendet werden sollen.

arePageNumbersHiddenOnWeb: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Gibt an, ob Seitenzahlen im Inhaltsverzeichnis enthalten sind.

arePageNumbersIncluded: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Gibt an, ob Seitenzahlen am rechten Rand im Inhaltsverzeichnis ausgerichtet werden.

arePageNumbersRightAligned: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Gibt die endende Überschriftenebene für das Inhaltsverzeichnis an. Muss ein Wert von 1 bis 9 und größer als upperHeadingLevelsein.

lowerHeadingLevel: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Ruft den Teil eines Dokuments ab, der dieses Inhaltsverzeichnis ist.

readonly range: Word.Range;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Gibt das Zeichen zwischen Einträgen und deren Seitenzahlen im Inhaltsverzeichnis an.

tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot";

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Gibt einen 1-Buchstaben-Bezeichner aus TC-Feldern an, der für das Inhaltsverzeichnis verwendet wird.

tableId: string;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Gibt die Startüberschriftenebene für das Inhaltsverzeichnis an. Muss ein Wert von 1 bis 9 und kleiner als lowerHeadingLevelsein.

upperHeadingLevel: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Löscht dieses Inhaltsverzeichnis.

delete(): void;

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(options?: Word.Interfaces.TableOfContentsLoadOptions): Word.TableOfContents;

Parameter

Gibt zurück

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames?: string | string[]): Word.TableOfContents;

Parameter

Gibt zurück

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.TableOfContents;

Parameter

Gibt zurück

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

set(properties: Interfaces.TableOfContentsUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameter

Gibt zurück

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Word.TableOfContents): void;

Parameter

Gibt zurück

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Word.TableOfContents Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.TableOfContentsData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Word.Interfaces.TableOfContentsData;

Gibt zurück

Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über .sync Aufrufe hinweg und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Auflistung ist, sollten Sie auch die übergeordnete Auflistung nachverfolgen.

track(): Word.TableOfContents;

Gibt zurück

Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen context.sync() , bevor die Speicherfreigabe wirksam wird.

untrack(): Word.TableOfContents;

Gibt zurück

Updates das gesamte Inhaltsverzeichnis.

updatePageNumbers(): void;

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]