Word.TableOfAuthorities class
Stellt ein Rechtsgrundlagenverzeichnis in einem Word-Dokument dar.
- Extends
Hinweise
Verwendet von
Eigenschaften
| bookmark | Gibt den Namen der Textmarke an, aus der Einträge im Normenverzeichnis gesammelt werden sollen. |
| category | Gibt die Kategorie der Einträge an, die in das Behördenverzeichnis aufgenommen werden sollen. Die Werte 0 bis 16 entsprechen den Elementen, die im Feld "Kategorie" des Dialogfelds "Rechtsgrundlagen" aufgeführt sind. Informationen dazu, wie Sie über die Word-Benutzeroberfläche darauf zugreifen, finden Sie unter Erstellen eines Berechtigungsverzeichnisses. |
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| entry |
Gibt ein Trennzeichen von bis zu fünf Zeichen an. Diese wird zwischen dem Eintrag im Rechtsgrundlagenverzeichnis und der Seitenzahl angezeigt. |
| is |
Gibt an, ob der Kategoriename für eine Gruppe von Einträgen im Berechtigungsverzeichnis angezeigt wird. |
| is |
Gibt an, ob die Einträge im Normenverzeichnis mit ihrer Formatierung in der Tabelle angezeigt werden. |
| is |
Gibt an, ob Verweise auf dieselbe Autorität, die auf fünf oder mehr Seiten wiederholt werden, durch "Passim" ersetzt werden. |
| page |
Gibt ein Trennzeichen von bis zu fünf Zeichen an. Dieser wird im Normenverzeichnis zwischen den einzelnen Seitenverweisen angezeigt. |
| page |
Gibt ein Trennzeichen von bis zu fünf Zeichen an. Dieser wird im Normenverzeichnis zwischen Seitenbereichen angezeigt. |
| range | Ruft den Teil eines Dokuments ab, der dieses Register der Berechtigungen darstellt. |
| sequence |
Gibt den Feldbezeichner "Sequenz" (SEQ) für das Berechtigungsverzeichnis an. |
| sequence |
Gibt ein Trennzeichen von bis zu fünf Zeichen an. Dieser wird im Normenverzeichnis zwischen der Sequenznummer und der Seitenzahl angezeigt. |
| tab |
Gibt das Füllzeichen an, das zwischen Einträgen und den zugehörigen Seitenzahlen im Normverzeichnis angezeigt wird. |
Methoden
| delete() | Löscht diese Rechtsgrundlagentabelle. |
| 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 |
Details zur Eigenschaft
bookmark
Gibt den Namen der Textmarke an, aus der Einträge im Normenverzeichnis gesammelt werden sollen.
bookmark: string;
Eigenschaftswert
string
Hinweise
category
Gibt die Kategorie der Einträge an, die in das Behördenverzeichnis aufgenommen werden sollen. Die Werte 0 bis 16 entsprechen den Elementen, die im Feld "Kategorie" des Dialogfelds "Rechtsgrundlagen" aufgeführt sind. Informationen dazu, wie Sie über die Word-Benutzeroberfläche darauf zugreifen, finden Sie unter Erstellen eines Berechtigungsverzeichnisses.
category: number;
Eigenschaftswert
number
Hinweise
context
Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;
Eigenschaftswert
entrySeparator
Gibt ein Trennzeichen von bis zu fünf Zeichen an. Diese wird zwischen dem Eintrag im Rechtsgrundlagenverzeichnis und der Seitenzahl angezeigt.
entrySeparator: string;
Eigenschaftswert
string
Hinweise
isCategoryHeaderIncluded
Gibt an, ob der Kategoriename für eine Gruppe von Einträgen im Berechtigungsverzeichnis angezeigt wird.
isCategoryHeaderIncluded: boolean;
Eigenschaftswert
boolean
Hinweise
isEntryFormattingKept
Gibt an, ob die Einträge im Normenverzeichnis mit ihrer Formatierung in der Tabelle angezeigt werden.
isEntryFormattingKept: boolean;
Eigenschaftswert
boolean
Hinweise
isPassimUsed
Gibt an, ob Verweise auf dieselbe Autorität, die auf fünf oder mehr Seiten wiederholt werden, durch "Passim" ersetzt werden.
isPassimUsed: boolean;
Eigenschaftswert
boolean
Hinweise
pageNumberSeparator
Gibt ein Trennzeichen von bis zu fünf Zeichen an. Dieser wird im Normenverzeichnis zwischen den einzelnen Seitenverweisen angezeigt.
pageNumberSeparator: string;
Eigenschaftswert
string
Hinweise
pageRangeSeparator
Gibt ein Trennzeichen von bis zu fünf Zeichen an. Dieser wird im Normenverzeichnis zwischen Seitenbereichen angezeigt.
pageRangeSeparator: string;
Eigenschaftswert
string
Hinweise
range
Ruft den Teil eines Dokuments ab, der dieses Register der Berechtigungen darstellt.
readonly range: Word.Range;
Eigenschaftswert
Hinweise
sequenceName
Gibt den Feldbezeichner "Sequenz" (SEQ) für das Berechtigungsverzeichnis an.
sequenceName: string;
Eigenschaftswert
string
Hinweise
sequenceSeparator
Gibt ein Trennzeichen von bis zu fünf Zeichen an. Dieser wird im Normenverzeichnis zwischen der Sequenznummer und der Seitenzahl angezeigt.
sequenceSeparator: string;
Eigenschaftswert
string
Hinweise
tabLeader
Gibt das Füllzeichen an, das zwischen Einträgen und den zugehörigen Seitenzahlen im Normverzeichnis angezeigt wird.
tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot";
Eigenschaftswert
Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"
Hinweise
Details zur Methode
delete()
Löscht diese Rechtsgrundlagentabelle.
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.TableOfAuthoritiesLoadOptions): Word.TableOfAuthorities;
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.TableOfAuthorities;
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.TableOfAuthorities;
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.TableOfAuthoritiesUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parameter
- properties
- Word.Interfaces.TableOfAuthoritiesUpdateData
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.TableOfAuthorities): void;
Parameter
- properties
- Word.TableOfAuthorities
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.TableOfAuthorities Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Word.Interfaces.TableOfAuthoritiesData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.
toJSON(): Word.Interfaces.TableOfAuthoritiesData;
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.TableOfAuthorities;
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.TableOfAuthorities;