Word.EditorCollection class
Stellt die Editoren in einem geschützten (schreibgeschützten) Word Dokument dar.
- Extends
Hinweise
Eigenschaften
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
Methoden
| add |
Gibt ein |
| add |
Gibt ein |
| add |
Gibt ein |
| get |
Gibt die Anzahl der Elemente in der Auflistung zurück. |
| get |
Ruft ein |
| 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 " |
| 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 über |
| 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 aufrufen |
Details zur Eigenschaft
context
Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
Details zur Methode
addById(editorId)
Gibt ein Editor Objekt zurück, das eine neue Berechtigung für den angegebenen Benutzer zum Ändern eines Bereichs innerhalb des Dokuments darstellt.
addById(editorId: string): Word.Editor;Parameter
- editorId
-
string
Der E-Mail-Alias des Benutzers (wenn er sich in derselben Domäne befindet) oder eine E-Mail-Adresse.
Gibt zurück
Hinweise
addByType(editorType)
Gibt ein Editor -Objekt zurück, das eine neue Berechtigung für die angegebene Gruppe von Benutzern zum Ändern eines Bereichs innerhalb des Dokuments darstellt.
addByType(editorType: Word.EditorType): Word.Editor;Parameter
- editorType
- Word.EditorType
Ein EditorType , das eine Gruppe von Benutzern darstellt.
Gibt zurück
Hinweise
addByType(editorType)
Gibt ein Editor -Objekt zurück, das eine neue Berechtigung für die angegebene Gruppe von Benutzern zum Ändern eines Bereichs innerhalb des Dokuments darstellt.
addByType(editorType: "Current" | "Editors" | "Everyone" | "Owners"): Word.Editor;Parameter
- editorType
-
"Current" | "Editors" | "Everyone" | "Owners"
Ein EditorType , das eine Gruppe von Benutzern darstellt.
Gibt zurück
Hinweise
getCount()
Gibt die Anzahl der Elemente in der Auflistung zurück.
getCount(): OfficeExtension.ClientResult<number>;Gibt zurück
OfficeExtension.ClientResult<number>
Hinweise
getItemAt(index)
Ruft ein Editor -Objekt anhand seines Indexes in der Auflistung ab.
getItemAt(index: number): Word.Editor;Parameter
- index
-
number
Der Index des abzurufenden Elements.
Gibt zurück
Hinweise
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.EditorCollection;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.EditorCollection;Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
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 das Objekt übergeben wird.) Während das ursprüngliche Word.EditorCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.EditorCollectionData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): {
[key: string]: string;
};Gibt zurück
{ [key: string]: string; }
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 ü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.EditorCollection;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 aufrufen context.sync() , bevor die Speicherfreigabe wirksam wird.
untrack(): Word.EditorCollection;