Neuerungen in Word JavaScript-API 1.4
WordApi 1.4 hat Unterstützung für Lesezeichen, Änderungsnachverfolgung, Kommentare, benutzerdefinierte XML-Teile, Felder und das Zusammenführen und Teilen von Tabellenzellen hinzugefügt.
API-Liste
In der folgenden Tabelle sind die APIs in Word JavaScript-API-Anforderungssatz 1.4 aufgeführt. Informationen zum Anzeigen der API-Referenzdokumentation für alle APIs, die von Word JavaScript-API-Anforderungssatz 1.4 oder früher unterstützt werden, finden Sie unter Word APIs im Anforderungssatz 1.4 oder früher.
Klasse | Felder | Beschreibung |
---|---|---|
Body | fields | Ruft die Auflistung von Feldobjekten im Text ab. |
getComments() | Ruft dem Text zugeordnete Kommentare ab. | |
getReviewedText(changeTrackingVersion?: Word. ChangeTrackingVersion) | Ruft überprüften Text basierend auf der ChangeTrackingVersion-Auswahl ab. | |
Kommentar | authorEmail | Ruft die E-Mail des Autors des Kommentars ab. |
authorName | Ruft den Namen des Autors des Kommentars ab. | |
content | Gibt den Inhalt des Kommentars als Nur-Text an. | |
contentRange | Gibt den Inhaltsbereich des Kommentars an. | |
creationDate | Ruft das Erstellungsdatum des Kommentars ab. | |
delete() | Löscht den Kommentar und seine Antworten. | |
getRange() | Ruft den Bereich im Standard Dokument ab, in dem sich der Kommentar befindet. | |
id | Ruft die ID des Kommentars ab. | |
replies | Ruft die Auflistung von Antwortobjekten ab, die dem Kommentar zugeordnet sind. | |
reply(replyText: string) | Fügt am Ende des Kommentarthreads eine neue Antwort hinzu. | |
Gelöst | Gibt die status des Kommentarthreads an. | |
CommentCollection | getFirst() | Ruft den ersten Kommentar in der Auflistung ab. |
getFirstOrNullObject() | Ruft den ersten Kommentar in der Auflistung ab. | |
items | Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab. | |
CommentContentRange | bold | Gibt einen Wert an, der angibt, ob der Kommentartext fett formatiert ist. |
hyperlink | Ruft den ersten Link in dem Bereich ab oder legt einen Link für den Bereich fest. | |
insertText(text: string, insertLocation: Word. InsertLocation | "Ersetzen" | "Start" | "Ende" | "Vor" | "Nach") | Fügt Text an der angegebenen Position in ein. | |
Isempty | Überprüft, ob die Länge des Bereichs 0 ist. | |
italic | Gibt einen Wert an, der angibt, ob der Kommentartext kursiv formatiert ist. | |
Durchgestrichen | Gibt einen Wert an, der angibt, ob der Kommentartext durchgestrichen ist. | |
text | Ruft den Text des Kommentarbereichs ab. | |
underline | Gibt einen Wert an, der den Unterstreichungstyp des Kommentartexts angibt. | |
CommentReply | authorEmail | Ruft die E-Mail des Autors der Kommentarantwort ab. |
authorName | Ruft den Namen des Autors der Kommentarantwort ab. | |
content | Gibt den Inhalt der Kommentarantwort an. | |
contentRange | Gibt den Inhaltsbereich von commentReply an. | |
creationDate | Ruft das Erstellungsdatum der Kommentarantwort ab. | |
delete() | Löscht die Kommentarantwort. | |
id | Ruft die ID der Kommentarantwort ab. | |
parentComment | Ruft den übergeordneten Kommentar dieser Antwort ab. | |
CommentReplyCollection | getFirst() | Ruft die erste Kommentarantwort in der Auflistung ab. |
getFirstOrNullObject() | Ruft die erste Kommentarantwort in der Auflistung ab. | |
items | Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab. | |
ContentControl | fields | Ruft die Auflistung von Feldobjekten im Inhaltssteuerelement ab. |
getComments() | Ruft kommentare ab, die dem Inhaltssteuerelement zugeordnet sind. | |
getReviewedText(changeTrackingVersion?: Word. ChangeTrackingVersion) | Ruft überprüften Text basierend auf der ChangeTrackingVersion-Auswahl ab. | |
CustomXmlPart | delete() | Löscht die benutzerdefinierte XML-Komponente. |
deleteAttribute(xpath: string, namespaceMappings: { [key: string]: string }, name: string) | Löscht ein Attribut mit dem angegebenen Namen aus dem von xpath identifizierten Element. | |
deleteElement(xpath: string, namespaceMappings: { [key: string]: string }) | Löscht das von xpath identifizierte Element. | |
getXml() | Ruft den vollständigen XML-Inhalt der benutzerdefinierten XML-Komponente ab. | |
id | Ruft die ID des benutzerdefinierten XML-Teils ab. | |
insertAttribute(xpath: string, namespaceMappings: { [key: string]: string }, name: string, value: string) | Fügt ein Attribut mit dem angegebenen Namen und Wert in das von xpath identifizierte Element ein. | |
insertElement(xpath: string, xml: string, namespaceMappings: { [key: string]: string }, index?: number) | Fügt den angegebenen XML-Code unter dem übergeordneten Element ein, das von xpath am untergeordneten Positionsindex identifiziert wird. | |
Namespaceuri | Ruft den Namespace-URI der benutzerdefinierten XML-Komponente ab. | |
query(xpath: string, namespaceMappings: { [key: string]: string }) | Fragt den XML-Inhalt des benutzerdefinierten XML-Teils ab. | |
setXml(xml: string) | Legt den vollständigen XML-Inhalt des benutzerdefinierten XML-Teils fest. | |
updateAttribute(xpath: string, namespaceMappings: { [key: string]: string }, name: string, value: string) | Updates den Wert eines Attributs mit dem angegebenen Namen des durch xpath identifizierten Elements. | |
updateElement(xpath: string, xml: string, namespaceMappings: { [key: string]: string }) | Updates den XML-Code des durch xpath identifizierten Elements. | |
CustomXmlPartCollection | add(xml: string) | Fügt dem Dokument eine neue benutzerdefinierte XML-Komponente hinzu. |
getByNamespace(namespaceUri: string) | Ruft eine neue bereichsbezogene Sammlung von benutzerdefinierten XML-Komponenten ab, deren Namespaces dem angegebenen Namespace entsprechen. | |
getCount() | Ruft die Anzahl der Elemente in der Auflistung ab. | |
getItem(id: string) | Ruft eine benutzerdefinierte XML-Komponente basierend auf ihrer ID ab. | |
getItemOrNullObject(id: string) | Ruft eine benutzerdefinierte XML-Komponente basierend auf ihrer ID ab. | |
items | Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab. | |
CustomXmlPartScopedCollection | getCount() | Ruft die Anzahl der Elemente in der Auflistung ab. |
getItem(id: string) | Ruft eine benutzerdefinierte XML-Komponente basierend auf ihrer ID ab. | |
getItemOrNullObject(id: string) | Ruft eine benutzerdefinierte XML-Komponente basierend auf ihrer ID ab. | |
getOnlyItem() | Wenn die Sammlung genau ein Element enthält, gibt diese Methode es zurück. | |
getOnlyItemOrNullObject() | Wenn die Sammlung genau ein Element enthält, gibt diese Methode es zurück. | |
items | Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab. | |
Dokument | changeTrackingMode | Gibt den ChangeTracking-Modus an. |
Customxmlparts | Ruft die benutzerdefinierten XML-Teile im Dokument ab. | |
deleteBookmark(name: string) | Löscht ein Lesezeichen aus dem Dokument, sofern vorhanden. | |
getBookmarkRange(name: string) | Ruft den Bereich eines Lesezeichens ab. | |
getBookmarkRangeOrNullObject(name: string) | Ruft den Bereich eines Lesezeichens ab. | |
Einstellungen | Ruft die Einstellungen des Add-Ins im Dokument ab. | |
Field | code | Ruft die Codeanweisung des Felds ab. |
getNext() | Ruft das nächste Feld ab. | |
getNextOrNullObject() | Ruft das nächste Feld ab. | |
parentBody | Ruft den übergeordneten Text des Felds ab. | |
parentContentControl | Ruft das Inhaltssteuerelement ab, das das Feld enthält. | |
parentContentControlOrNullObject | Ruft das Inhaltssteuerelement ab, das das Feld enthält. | |
parentTable | Ruft die Tabelle ab, die das Feld enthält. | |
parentTableCell | Ruft die Tabellenzelle ab, die das Feld enthält. | |
parentTableCellOrNullObject | Ruft die Tabellenzelle ab, die das Feld enthält. | |
parentTableOrNullObject | Ruft die Tabelle ab, die das Feld enthält. | |
result | Ruft die Ergebnisdaten des Felds ab. | |
FieldCollection | getFirst() | Ruft das erste Feld in dieser Auflistung ab. |
getFirstOrNullObject() | Ruft das erste Feld in dieser Auflistung ab. | |
items | Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab. | |
Paragraph | fields | Ruft die Auflistung der Felder im Absatz ab. |
getComments() | Ruft dem Absatz zugeordnete Kommentare ab. | |
getReviewedText(changeTrackingVersion?: Word. ChangeTrackingVersion) | Ruft überprüften Text basierend auf der ChangeTrackingVersion-Auswahl ab. | |
Range | fields | Ruft die Auflistung von Feldobjekten im Bereich ab. |
getBookmarks(includeHidden?: boolean, includeAdjacent?: boolean) | Ruft die Namen aller Lesezeichen im Bereich ab oder überlappen den Bereich. | |
getComments() | Ruft dem Bereich zugeordnete Kommentare ab. | |
getReviewedText(changeTrackingVersion?: Word. ChangeTrackingVersion) | Ruft überprüften Text basierend auf der ChangeTrackingVersion-Auswahl ab. | |
insertBookmark(name: string) | Fügt ein Lesezeichen in den Bereich ein. | |
insertComment(commentText: string) | Fügen Sie einen Kommentar für den Bereich ein. | |
Einstellung | delete() | Löscht die Einstellung. |
key | Ruft den Schlüssel der Einstellung ab. | |
value | Gibt den Wert der Einstellung an. | |
SettingCollection | add(key: string, value: any) | Erstellt eine neue Einstellung oder legt eine vorhandene Einstellung fest. |
deleteAll() | Löscht alle Einstellungen in diesem Add-In. | |
getCount() | Ruft die Anzahl der Einstellungen ab. | |
getItem(key: string) | Ruft ein Einstellungsobjekt anhand seines Schlüssels ab, bei dem die Groß-/Kleinschreibung beachtet wird. | |
getItemOrNullObject(key: string) | Ruft ein Einstellungsobjekt anhand seines Schlüssels ab, bei dem die Groß-/Kleinschreibung beachtet wird. | |
items | Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab. | |
Table | fields | Ruft die Auflistung von Feldobjekten in der Tabelle ab. |
mergeCells(topRow: number, firstCell: number, bottomRow: number, lastCell: number) | Führt die Zellen zusammen, die inklusive durch eine erste und letzte Zelle begrenzt sind. | |
TableCell | split(rowCount: number, columnCount: number) | Teilt die Zelle in die angegebene Anzahl von Zeilen und Spalten auf. |
TableRow | fields | Ruft die Auflistung von Feldobjekten in der Tabellenzeile ab. |
merge() | Führt die Zeile in einer Zelle zusammen. |
Siehe auch
Zusammenarbeit auf GitHub
Die Quelle für diesen Inhalt finden Sie auf GitHub, wo Sie auch Issues und Pull Requests erstellen und überprüfen können. Weitere Informationen finden Sie in unserem Leitfaden für Mitwirkende.
Office Add-ins