Word.TableOfAuthorities class

Gibt den Namen des Lesezeichens an, aus dem Einträge in einem Rechtsgrundlagenverzeichnis erfasst werden sollen.

bookmark: string;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Gibt die Kategorie der Einträge an, die in das Rechtsgrundlagenverzeichnis aufgenommen werden sollen. Die Werte 0 bis 16 entsprechen den Elementen, die im Feld Kategorie des Dialogfelds "Autoritätsverzeichnis" aufgeführt sind. Informationen zum Zugreifen darauf über die Word Benutzeroberfläche finden Sie unter Erstellen eines Rechtsgrundlagenverzeichnisses.

category: number;

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 ein Trennzeichen mit bis zu fünf Zeichen an. Dies wird zwischen dem Eintrag des Rechtsgrundlagenverzeichnisses und seiner Seitenzahl angezeigt.

entrySeparator: string;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Gibt an, ob der Kategoriename für eine Gruppe von Einträgen im Rechtsgrundlagenverzeichnis angezeigt wird.

isCategoryHeaderIncluded: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Gibt an, ob die Einträge im Rechtsgrundlagenverzeichnis mit ihrer Formatierung in der Tabelle angezeigt werden.

isEntryFormattingKept: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Gibt an, ob Verweise auf dieselbe Autorität, die auf fünf oder mehr Seiten wiederholt werden, durch "Passim" ersetzt werden.

isPassimUsed: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Gibt ein Trennzeichen mit bis zu fünf Zeichen an. Dies wird zwischen einzelnen Seitenverweisen im Rechtsgrundlagenverzeichnis angezeigt.

pageNumberSeparator: string;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Gibt ein Trennzeichen mit bis zu fünf Zeichen an. Dies wird zwischen Seitenbereichen im Rechtsgrundlagenverzeichnis angezeigt.

pageRangeSeparator: string;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Ruft den Teil eines Dokuments ab, bei dem es sich um dieses Rechtsgrundlagenverzeichnis handelt.

readonly range: Word.Range;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Gibt den SeQ-Feldbezeichner (Sequence) für das Rechtsgrundlagenverzeichnis an.

sequenceName: string;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Gibt ein Trennzeichen mit bis zu fünf Zeichen an. Diese wird zwischen der Sequenznummer und der Seitenzahl im Rechtsgrundlagenverzeichnis angezeigt.

sequenceSeparator: string;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Gibt das Führungszeichen an, das zwischen Einträgen und den zugehörigen Seitenzahlen im Rechtsgrundlagenverzeichnis angezeigt wird.

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

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Löscht dieses Rechtsgrundlagenverzeichnis.

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.TableOfAuthoritiesLoadOptions): Word.TableOfAuthorities;

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.TableOfAuthorities;

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.TableOfAuthorities;

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.TableOfAuthoritiesUpdateData, 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.TableOfAuthorities): 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.TableOfAuthorities Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.TableOfAuthoritiesData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Word.Interfaces.TableOfAuthoritiesData;

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.TableOfAuthorities;

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.TableOfAuthorities;

Gibt zurück