Word.TableOfFigures class
Stellt ein Abbildungsverzeichnis in einem Word-Dokument dar.
- Extends
Hinweise
Verwendet von
Eigenschaften
| additional |
Ruft die zusätzlichen Formatvorlagen ab, die für das Abbildungsverzeichnis verwendet werden. Die Standardformatvorlagen "Überschrift 1" bis "Überschrift 9" sind in dieser Sammlung nicht enthalten. |
| are |
Gibt an, ob integrierte Formatvorlagen für Überschriften für das Abbildungsverzeichnis verwendet werden. |
| are |
Gibt an, ob Inhaltsverzeichniseintragsfelder (Table of Contents Entry, TC) in das Abbildungsverzeichnis eingeschlossen sind. |
| are |
Gibt an, ob Einträge im Abbildungsverzeichnis beim Veröffentlichen im Web als Hyperlinks formatiert werden sollen. |
| are |
Gibt an, ob die Seitenzahlen im Abbildungsverzeichnis bei der Veröffentlichung im Web ausgeblendet werden sollen. |
| are |
Gibt an, ob Seitenzahlen im Abbildungsverzeichnis enthalten sind. |
| are |
Gibt an, ob Seitenzahlen am rechten Rand des Abbildungsverzeichnisses ausgerichtet sind. |
| caption |
Gibt die Bezeichnung an, mit der die Elemente identifiziert werden, die in das Abbildungsverzeichnis aufgenommen werden sollen. |
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| is |
Gibt an, ob die Untertitel und die Untertitel im Abbildungsverzeichnis enthalten sind. |
| lower |
Gibt die Endüberschriftenebene für das Abbildungsverzeichnis an. Muss ein Wert zwischen 1 und 9 und größer |
| range | Ruft den Teil eines Dokuments ab, der dieses Abbildungsverzeichnis darstellt. |
| tab |
Gibt das Zeichen zwischen Einträgen und ihren Seitenzahlen im Abbildungsverzeichnis an. |
| table |
Gibt einen einbuchstabigen Bezeichner aus Inhaltsverzeichniseintrags-Feldern an, der für das Abbildungsverzeichnis verwendet wird. |
| upper |
Gibt die Startüberschriftenebene für das Abbildungsverzeichnis an. Muss ein Wert zwischen 1 und 9 und kleiner als |
Methoden
| delete() | Löscht dieses Abbildungsverzeichnis. |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| set(properties, options) | 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) | Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt. |
| toJSON() | Überschreibt die JavaScript-Methode |
| track() | 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 aufrufübergreifend |
| untrack() | 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 einen Aufruf durchführen |
| update |
Updates das gesamte Abbildungsverzeichnis. |
Details zur Eigenschaft
additionalHeadingStyles
Ruft die zusätzlichen Formatvorlagen ab, die für das Abbildungsverzeichnis verwendet werden. Die Standardformatvorlagen "Überschrift 1" bis "Überschrift 9" sind in dieser Sammlung nicht enthalten.
readonly additionalHeadingStyles: Word.HeadingStyleCollection;Eigenschaftswert
Hinweise
areBuiltInHeadingStylesUsed
Gibt an, ob integrierte Formatvorlagen für Überschriften für das Abbildungsverzeichnis verwendet werden.
areBuiltInHeadingStylesUsed: boolean;Eigenschaftswert
boolean
Hinweise
areFieldsUsed
Gibt an, ob Inhaltsverzeichniseintragsfelder (Table of Contents Entry, TC) in das Abbildungsverzeichnis eingeschlossen sind.
areFieldsUsed: boolean;Eigenschaftswert
boolean
Hinweise
areHyperlinksUsedOnWeb
Gibt an, ob Einträge im Abbildungsverzeichnis beim Veröffentlichen im Web als Hyperlinks formatiert werden sollen.
areHyperlinksUsedOnWeb: boolean;Eigenschaftswert
boolean
Hinweise
arePageNumbersHiddenOnWeb
Gibt an, ob die Seitenzahlen im Abbildungsverzeichnis bei der Veröffentlichung im Web ausgeblendet werden sollen.
arePageNumbersHiddenOnWeb: boolean;Eigenschaftswert
boolean
Hinweise
arePageNumbersIncluded
Gibt an, ob Seitenzahlen im Abbildungsverzeichnis enthalten sind.
arePageNumbersIncluded: boolean;Eigenschaftswert
boolean
Hinweise
arePageNumbersRightAligned
Gibt an, ob Seitenzahlen am rechten Rand des Abbildungsverzeichnisses ausgerichtet sind.
arePageNumbersRightAligned: boolean;Eigenschaftswert
boolean
Hinweise
captionLabel
Gibt die Bezeichnung an, mit der die Elemente identifiziert werden, die in das Abbildungsverzeichnis aufgenommen werden sollen.
captionLabel: string;Eigenschaftswert
string
Hinweise
context
Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
isLabelIncluded
Gibt an, ob die Untertitel und die Untertitel im Abbildungsverzeichnis enthalten sind.
isLabelIncluded: boolean;Eigenschaftswert
boolean
Hinweise
lowerHeadingLevel
Gibt die Endüberschriftenebene für das Abbildungsverzeichnis an. Muss ein Wert zwischen 1 und 9 und größer upperHeadingLevelals sein.
lowerHeadingLevel: number;Eigenschaftswert
number
Hinweise
range
Ruft den Teil eines Dokuments ab, der dieses Abbildungsverzeichnis darstellt.
readonly range: Word.Range;Eigenschaftswert
Hinweise
tabLeader
Gibt das Zeichen zwischen Einträgen und ihren Seitenzahlen im Abbildungsverzeichnis an.
tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot";Eigenschaftswert
Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"
Hinweise
tableId
Gibt einen einbuchstabigen Bezeichner aus Inhaltsverzeichniseintrags-Feldern an, der für das Abbildungsverzeichnis verwendet wird.
tableId: string;Eigenschaftswert
string
Hinweise
upperHeadingLevel
Gibt die Startüberschriftenebene für das Abbildungsverzeichnis an. Muss ein Wert zwischen 1 und 9 und kleiner als lowerHeadingLevelsein.
upperHeadingLevel: number;Eigenschaftswert
number
Hinweise
Details zur Methode
delete()
Löscht dieses Abbildungsverzeichnis.
delete(): void;Gibt zurück
void
Hinweise
load(options)
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.TableOfFiguresLoadOptions): Word.TableOfFigures;Parameter
Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.
Gibt zurück
load(propertyNames)
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.TableOfFigures;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
load(propertyNamesAndPaths)
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.TableOfFigures;Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
set(properties, options)
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.TableOfFiguresUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- Word.Interfaces.TableOfFiguresUpdateData
Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.
- options
- OfficeExtension.UpdateOptions
Bietet eine Option zum Unterdrücken von Fehlern, wenn das properties-Objekt versucht, schreibgeschützte Eigenschaften festzulegen.
Gibt zurück
void
set(properties)
Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
set(properties: Word.TableOfFigures): void;Parameter
- properties
- Word.TableOfFigures
Gibt zurück
void
toJSON()
Ü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 sie übergeben wird.) Während das ursprüngliche Word.TableOfFigures Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Word.Interfaces.TableOfFiguresData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.
toJSON(): Word.Interfaces.TableOfFiguresData;Gibt zurück
track()
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 aufrufübergreifend .sync 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 ein "InvalidObjectPath"-Fehler angezeigt wird, müssen Sie das Objekt der nachverfolgten Objektsammlung hinzufügen, wenn das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Sammlung ist, sollten Sie auch die übergeordnete Sammlung nachverfolgen.
track(): Word.TableOfFigures;Gibt zurück
untrack()
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 einen Aufruf durchführen context.sync() , bevor die Speicherfreigabe wirksam wird.
untrack(): Word.TableOfFigures;Gibt zurück
updatePageNumbers()
Updates das gesamte Abbildungsverzeichnis.
updatePageNumbers(): void;Gibt zurück
void