word package
Klassen
Word.Body |
Steht für den Textkörper eines Dokuments oder Abschnitts. |
Word.ContentControl |
Stellt ein Inhaltssteuerelement dar. Inhaltssteuerelemente sind gebunden und potenziell beschrifteten Bereiche in einem Dokument, das als Container für bestimmte Arten von Inhalten dienen. Einzelne Inhaltssteuerelemente können Inhalte wie Bilder, Tabellen oder Absätze mit formatiertem Text enthalten. Derzeit werden nur Rich-Text-, Nur-Text- und Kontrollkästchen-Inhaltssteuerelemente unterstützt. |
Word.ContentControlCollection |
Enthält eine Auflistung von Word. ContentControl-Objekte. Inhaltssteuerelemente sind gebundene und möglicherweise mit Beschriftungen versehene Bereiche in einem Dokument, die als Container für bestimmte Typen von Inhalt dienen. Einzelne Inhaltssteuerelemente können Inhalte wie Bilder, Tabellen oder Absätze mit formatiertem Text enthalten. Derzeit werden nur Rich-Text- und Nur-Text-Inhaltssteuerelemente unterstützt. |
Word.Document |
Das Document-Objekt ist das Objekt auf oberster Ebene. Ein Document-Objekt enthält mindestens einen Abschnitt, Inhaltssteuerelemente und Text, der den Inhalt des Dokuments enthält. |
Word.Font |
Stellt eine Schriftart dar. |
Word.InlinePicture |
Stellt ein eingebundenes Bild dar. |
Word.InlinePictureCollection |
Enthält eine Auflistung von Word. InlinePicture-Objekte. |
Word.Paragraph |
Stellt einen einzelnen Absatz in einer Auswahl, einem Bereich, Inhaltssteuerelement oder Hauptteil des Dokuments dar. |
Word.ParagraphCollection |
Enthält eine Auflistung von Word. Absatzobjekte. |
Word.Range |
Stellt einen zusammenhängenden Bereich in einem Dokument dar. |
Word.RangeCollection |
Enthält eine Auflistung von Word. Bereichsobjekte. |
Word.RequestContext |
Das RequestContext-Objekt erleichtert Anforderungen an die Word Anwendung. Da das Office-Add-In und die Word-Anwendung in zwei verschiedenen Prozessen ausgeführt werden, ist der Anforderungskontext erforderlich, um zugriff auf das Word-Objektmodell aus dem Add-In zu erhalten. |
Word.SearchOptions |
Gibt die Optionen an, die in einem Suchvorgang eingeschlossen werden sollen. Weitere Informationen zur Verwendung von Suchoptionen in den Word JavaScript-APIs finden Sie unter Verwenden von Suchoptionen zum Suchen von Text in Ihrem Word-Add-In. |
Word.Section |
Stellt einen Abschnitt in ein Word-Dokument dar. |
Word.SectionCollection |
Enthält die Auflistung der Word des Dokuments. Section-Objekte. |
Schnittstellen
Word.Interfaces.AnnotationCollectionData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.AnnotationCollectionUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.AnnotationData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.BodyData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.BodyLoadOptions |
Steht für den Textkörper eines Dokuments oder Abschnitts. |
Word.Interfaces.BodyUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.BorderCollectionData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.BorderCollectionUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.BorderData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.BorderUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.CheckboxContentControlData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.CheckboxContentControlUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.CollectionLoadOptions |
Bietet Möglichkeiten zum Laden von Eigenschaften nur einer Teilmenge von Membern einer Auflistung. |
Word.Interfaces.ComboBoxContentControlData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.CommentCollectionData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.CommentCollectionUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.CommentContentRangeData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.CommentContentRangeUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.CommentData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.CommentReplyCollectionData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.CommentReplyCollectionUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.CommentReplyData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.CommentReplyUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.CommentUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.ContentControlCollectionData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.ContentControlCollectionLoadOptions |
Enthält eine Auflistung von Word. ContentControl-Objekte. Inhaltssteuerelemente sind gebundene und möglicherweise mit Beschriftungen versehene Bereiche in einem Dokument, die als Container für bestimmte Typen von Inhalt dienen. Einzelne Inhaltssteuerelemente können Inhalte wie Bilder, Tabellen oder Absätze mit formatiertem Text enthalten. Derzeit werden nur Rich-Text- und Nur-Text-Inhaltssteuerelemente unterstützt. |
Word.Interfaces.ContentControlCollectionUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.ContentControlData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.ContentControlListItemCollectionData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.ContentControlListItemCollectionUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.ContentControlListItemData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.ContentControlListItemUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.ContentControlLoadOptions |
Stellt ein Inhaltssteuerelement dar. Inhaltssteuerelemente sind gebunden und potenziell beschrifteten Bereiche in einem Dokument, das als Container für bestimmte Arten von Inhalten dienen. Einzelne Inhaltssteuerelemente können Inhalte wie Bilder, Tabellen oder Absätze mit formatiertem Text enthalten. Derzeit werden nur Rich-Text-, Nur-Text- und Kontrollkästchen-Inhaltssteuerelemente unterstützt. |
Word.Interfaces.ContentControlUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.CritiqueAnnotationData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.CustomPropertyCollectionData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.CustomPropertyCollectionUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.CustomPropertyData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.CustomPropertyUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.CustomXmlPartCollectionData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.CustomXmlPartCollectionUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.CustomXmlPartData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.CustomXmlPartScopedCollectionData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.CustomXmlPartScopedCollectionUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.DocumentCreatedData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.DocumentCreatedUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.DocumentData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.DocumentLoadOptions |
Das Document-Objekt ist das Objekt auf oberster Ebene. Ein Document-Objekt enthält mindestens einen Abschnitt, Inhaltssteuerelemente und Text, der den Inhalt des Dokuments enthält. |
Word.Interfaces.DocumentPropertiesData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.DocumentPropertiesUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.DocumentUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.DropDownListContentControlData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.FieldCollectionData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.FieldCollectionUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.FieldData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.FieldUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.FontData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.FontLoadOptions |
Stellt eine Schriftart dar. |
Word.Interfaces.FontUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.InlinePictureCollectionData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.InlinePictureCollectionLoadOptions |
Enthält eine Auflistung von Word. InlinePicture-Objekte. |
Word.Interfaces.InlinePictureCollectionUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.InlinePictureData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.InlinePictureLoadOptions |
Stellt ein eingebundenes Bild dar. |
Word.Interfaces.InlinePictureUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.ListCollectionData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.ListCollectionUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.ListData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.ListItemData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.ListItemUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.ListLevelCollectionData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.ListLevelCollectionUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.ListLevelData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.ListLevelUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.ListTemplateData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.ListTemplateUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.NoteItemCollectionData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.NoteItemCollectionUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.NoteItemData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.NoteItemUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.ParagraphCollectionData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.ParagraphCollectionLoadOptions |
Enthält eine Auflistung von Word. Absatzobjekte. |
Word.Interfaces.ParagraphCollectionUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.ParagraphData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.ParagraphFormatData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.ParagraphFormatUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.ParagraphLoadOptions |
Stellt einen einzelnen Absatz in einer Auswahl, einem Bereich, Inhaltssteuerelement oder Hauptteil des Dokuments dar. |
Word.Interfaces.ParagraphUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.RangeCollectionData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.RangeCollectionLoadOptions |
Enthält eine Auflistung von Word. Bereichsobjekte. |
Word.Interfaces.RangeCollectionUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.RangeData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.RangeLoadOptions |
Stellt einen zusammenhängenden Bereich in einem Dokument dar. |
Word.Interfaces.RangeUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.SearchOptionsData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.SearchOptionsLoadOptions |
Gibt die Optionen an, die in einem Suchvorgang eingeschlossen werden sollen. Weitere Informationen zur Verwendung von Suchoptionen in den Word JavaScript-APIs finden Sie unter Verwenden von Suchoptionen zum Suchen von Text in Ihrem Word-Add-In. |
Word.Interfaces.SearchOptionsUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.SectionCollectionData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.SectionCollectionLoadOptions |
Enthält die Auflistung der Word des Dokuments. Section-Objekte. |
Word.Interfaces.SectionCollectionUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.SectionData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.SectionLoadOptions |
Stellt einen Abschnitt in ein Word-Dokument dar. |
Word.Interfaces.SectionUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.SettingCollectionData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.SettingCollectionUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.SettingData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.SettingUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.ShadingData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.ShadingUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.StyleCollectionData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.StyleCollectionUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.StyleData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.StyleUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.TableBorderData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.TableBorderUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.TableCellCollectionData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.TableCellCollectionUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.TableCellData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.TableCellUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.TableCollectionData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.TableCollectionUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.TableData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.TableRowCollectionData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.TableRowCollectionUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.TableRowData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.TableRowUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.TableStyleData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.TableStyleUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.TableUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.TrackedChangeCollectionData |
Eine Schnittstelle, die die durch Aufrufen |
Word.Interfaces.TrackedChangeCollectionUpdateData |
Eine Schnittstelle zum Aktualisieren von Daten für das |
Word.Interfaces.TrackedChangeData |
Eine Schnittstelle, die die durch Aufrufen |
Enumerationen
Word.Alignment | |
Word.BreakType |
Gibt die Form eines Umbruchs an. |
Word.ContentControlAppearance |
ContentControl-Darstellung. |
Word.ContentControlType |
Gibt unterstützte Inhaltssteuerelementtypen und Untertypen an. |
Word.ErrorCodes | |
Word.HeaderFooterType | |
Word.InsertLocation |
Die Einfügepositionstypen. |
Word.SaveBehavior |
Gibt das Speicherverhalten für |
Word.SelectionMode |
Diese Enumeration legt fest, wo sich der Cursor (Einfügemarke) im Dokument nach einer Auswahl befindet. |
Word.UnderlineType |
Die unterstützten Formatvorlagen für das Unterstreichungsformat. |
Functions
Word. |
Führt ein Batchskript aus, das Aktionen für das Word Objektmodell unter Verwendung des RequestContext der zuvor erstellten API-Objekte ausführt. |
Word. |
Führt ein Batchskript aus, das Aktionen für das Word Objektmodell unter Verwendung des RequestContext eines zuvor erstellten API-Objekts ausführt. Wenn die Zusage aufgelöst wird, werden alle nachverfolgten Objekte, die während der Ausführung automatisch zugeordnet wurden, freigegeben. |
Word. |
Führt ein Batchskript aus, das Aktionen für das Word-Objektmodell unter Verwendung eines neuen RequestContext ausführt. Wenn die Zusage aufgelöst wird, werden alle nachverfolgten Objekte, die während der Ausführung automatisch zugeordnet wurden, freigegeben. |
Details zur Funktion
Word.run(objects, batch)
Führt ein Batchskript aus, das Aktionen für das Word Objektmodell unter Verwendung des RequestContext der zuvor erstellten API-Objekte ausführt.
export function run<T>(objects: OfficeExtension.ClientObject[], batch: (context: Word.RequestContext) => Promise<T>): Promise<T>;
Parameter
- objects
Ein Array von zuvor erstellten API-Objekten. Das Array wird überprüft, um sicherzustellen, dass alle Objekte denselben Kontext verwenden. Der Batch verwendet diesen freigegebenen RequestContext. Dies bedeutet, dass alle Änderungen, die auf diese Objekte angewendet werden, von context.sync()
übernommen werden.
- batch
-
(context: Word.RequestContext) => Promise<T>
Eine Funktion, die einen RequestContext akzeptiert und eine Zusage zurückgibt (in der Regel nur das Ergebnis von context.sync()
). Der Kontextparameter erleichtert Anforderungen an die Word Anwendung. Da das Office-Add-In und die Word Anwendung in zwei verschiedenen Prozessen ausgeführt werden, ist RequestContext erforderlich, um zugriff auf das Word Objektmodell aus dem Add-In zu erhalten.
Gibt zurück
Promise<T>
Word.run(object, batch)
Führt ein Batchskript aus, das Aktionen für das Word Objektmodell unter Verwendung des RequestContext eines zuvor erstellten API-Objekts ausführt. Wenn die Zusage aufgelöst wird, werden alle nachverfolgten Objekte, die während der Ausführung automatisch zugeordnet wurden, freigegeben.
export function run<T>(object: OfficeExtension.ClientObject, batch: (context: Word.RequestContext) => Promise<T>): Promise<T>;
Parameter
- object
- OfficeExtension.ClientObject
Ein zuvor erstelltes API-Objekt. Der Batch verwendet denselben RequestContext wie das übergebene Objekt. Dies bedeutet, dass alle Änderungen, die auf das Objekt angewendet werden, von context.sync()
übernommen werden.
- batch
-
(context: Word.RequestContext) => Promise<T>
Eine Funktion, die einen RequestContext akzeptiert und eine Zusage zurückgibt (in der Regel nur das Ergebnis von context.sync()
). Der Kontextparameter erleichtert Anforderungen an die Word Anwendung. Da das Office-Add-In und die Word Anwendung in zwei verschiedenen Prozessen ausgeführt werden, ist RequestContext erforderlich, um zugriff auf das Word Objektmodell aus dem Add-In zu erhalten.
Gibt zurück
Promise<T>
Word.run(batch)
Führt ein Batchskript aus, das Aktionen für das Word-Objektmodell unter Verwendung eines neuen RequestContext ausführt. Wenn die Zusage aufgelöst wird, werden alle nachverfolgten Objekte, die während der Ausführung automatisch zugeordnet wurden, freigegeben.
export function run<T>(batch: (context: Word.RequestContext) => Promise<T>): Promise<T>;
Parameter
- batch
-
(context: Word.RequestContext) => Promise<T>
Eine Funktion, die einen RequestContext akzeptiert und eine Zusage zurückgibt (in der Regel nur das Ergebnis von context.sync()
). Der Kontextparameter erleichtert Anforderungen an die Word Anwendung. Da das Office-Add-In und die Word Anwendung in zwei verschiedenen Prozessen ausgeführt werden, ist RequestContext erforderlich, um zugriff auf das Word Objektmodell aus dem Add-In zu erhalten.
Gibt zurück
Promise<T>
Office Add-ins