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 annotationCollection.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.AnnotationCollectionUpdateData

Eine Schnittstelle zum Aktualisieren von Daten für das AnnotationCollection-Objekt zur Verwendung in annotationCollection.set({ ... }).

Word.Interfaces.AnnotationData

Eine Schnittstelle, die die durch Aufrufen annotation.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.BodyData

Eine Schnittstelle, die die durch Aufrufen body.toJSON()von zurückgegebenen Daten beschreibt.

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 Body-Objekt zur Verwendung in body.set({ ... }).

Word.Interfaces.CheckboxContentControlData

Eine Schnittstelle, die die durch Aufrufen checkboxContentControl.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.CheckboxContentControlUpdateData

Eine Schnittstelle zum Aktualisieren von Daten im CheckboxContentControl-Objekt zur Verwendung in checkboxContentControl.set({ ... }).

Word.Interfaces.CollectionLoadOptions

Bietet Möglichkeiten zum Laden von Eigenschaften nur einer Teilmenge von Membern einer Auflistung.

Word.Interfaces.CommentCollectionData

Eine Schnittstelle, die die durch Aufrufen commentCollection.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.CommentCollectionUpdateData

Eine Schnittstelle zum Aktualisieren von Daten im CommentCollection-Objekt zur Verwendung in commentCollection.set({ ... }).

Word.Interfaces.CommentContentRangeData

Eine Schnittstelle, die die durch Aufrufen commentContentRange.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.CommentContentRangeUpdateData

Eine Schnittstelle zum Aktualisieren von Daten für das CommentContentRange-Objekt zur Verwendung in commentContentRange.set({ ... }).

Word.Interfaces.CommentData

Eine Schnittstelle, die die durch Aufrufen comment.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.CommentReplyCollectionData

Eine Schnittstelle, die die durch Aufrufen commentReplyCollection.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.CommentReplyCollectionUpdateData

Eine Schnittstelle zum Aktualisieren von Daten für das CommentReplyCollection-Objekt zur Verwendung in commentReplyCollection.set({ ... }).

Word.Interfaces.CommentReplyData

Eine Schnittstelle, die die durch Aufrufen commentReply.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.CommentReplyUpdateData

Eine Schnittstelle zum Aktualisieren von Daten im CommentReply-Objekt zur Verwendung in commentReply.set({ ... }).

Word.Interfaces.CommentUpdateData

Eine Schnittstelle zum Aktualisieren von Daten für das Comment-Objekt zur Verwendung in comment.set({ ... }).

Word.Interfaces.ContentControlCollectionData

Eine Schnittstelle, die die durch Aufrufen contentControlCollection.toJSON()von zurückgegebenen Daten beschreibt.

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 ContentControlCollection-Objekt zur Verwendung in contentControlCollection.set({ ... }).

Word.Interfaces.ContentControlData

Eine Schnittstelle, die die durch Aufrufen contentControl.toJSON()von zurückgegebenen Daten beschreibt.

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 ContentControl-Objekt zur Verwendung in contentControl.set({ ... }).

Word.Interfaces.CritiqueAnnotationData

Eine Schnittstelle, die die durch Aufrufen critiqueAnnotation.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.CustomPropertyCollectionData

Eine Schnittstelle, die die durch Aufrufen customPropertyCollection.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.CustomPropertyCollectionUpdateData

Eine Schnittstelle zum Aktualisieren von Daten im CustomPropertyCollection-Objekt zur Verwendung in customPropertyCollection.set({ ... }).

Word.Interfaces.CustomPropertyData

Eine Schnittstelle, die die durch Aufrufen customProperty.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.CustomPropertyUpdateData

Eine Schnittstelle zum Aktualisieren von Daten für das CustomProperty-Objekt zur Verwendung in customProperty.set({ ... }).

Word.Interfaces.CustomXmlPartCollectionData

Eine Schnittstelle, die die durch Aufrufen customXmlPartCollection.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.CustomXmlPartCollectionUpdateData

Eine Schnittstelle zum Aktualisieren von Daten im CustomXmlPartCollection-Objekt zur Verwendung in customXmlPartCollection.set({ ... }).

Word.Interfaces.CustomXmlPartData

Eine Schnittstelle, die die durch Aufrufen customXmlPart.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.CustomXmlPartScopedCollectionData

Eine Schnittstelle, die die durch Aufrufen customXmlPartScopedCollection.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.CustomXmlPartScopedCollectionUpdateData

Eine Schnittstelle zum Aktualisieren von Daten für das CustomXmlPartScopedCollection-Objekt zur Verwendung in customXmlPartScopedCollection.set({ ... }).

Word.Interfaces.DocumentCreatedData

Eine Schnittstelle, die die durch Aufrufen documentCreated.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.DocumentCreatedUpdateData

Eine Schnittstelle zum Aktualisieren von Daten für das DocumentCreated-Objekt zur Verwendung in documentCreated.set({ ... }).

Word.Interfaces.DocumentData

Eine Schnittstelle, die die durch Aufrufen document.toJSON()von zurückgegebenen Daten beschreibt.

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 documentProperties.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.DocumentPropertiesUpdateData

Eine Schnittstelle zum Aktualisieren von Daten im DocumentProperties-Objekt zur Verwendung in documentProperties.set({ ... }).

Word.Interfaces.DocumentUpdateData

Eine Schnittstelle zum Aktualisieren von Daten im Document-Objekt zur Verwendung in document.set({ ... }).

Word.Interfaces.FieldCollectionData

Eine Schnittstelle, die die durch Aufrufen fieldCollection.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.FieldCollectionUpdateData

Eine Schnittstelle zum Aktualisieren von Daten für das FieldCollection-Objekt zur Verwendung in fieldCollection.set({ ... }).

Word.Interfaces.FieldData

Eine Schnittstelle, die die durch Aufrufen field.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.FieldUpdateData

Eine Schnittstelle zum Aktualisieren von Daten für das Field-Objekt zur Verwendung in field.set({ ... }).

Word.Interfaces.FontData

Eine Schnittstelle, die die durch Aufrufen font.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.FontLoadOptions

Stellt eine Schriftart dar.

Word.Interfaces.FontUpdateData

Eine Schnittstelle zum Aktualisieren von Daten für das Font-Objekt zur Verwendung in font.set({ ... }).

Word.Interfaces.InlinePictureCollectionData

Eine Schnittstelle, die die durch Aufrufen inlinePictureCollection.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.InlinePictureCollectionLoadOptions

Enthält eine Auflistung von Word. InlinePicture-Objekte.

Word.Interfaces.InlinePictureCollectionUpdateData

Eine Schnittstelle zum Aktualisieren von Daten für das InlinePictureCollection-Objekt zur Verwendung in inlinePictureCollection.set({ ... }).

Word.Interfaces.InlinePictureData

Eine Schnittstelle, die die durch Aufrufen inlinePicture.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.InlinePictureLoadOptions

Stellt ein eingebundenes Bild dar.

Word.Interfaces.InlinePictureUpdateData

Eine Schnittstelle zum Aktualisieren von Daten für das InlinePicture-Objekt zur Verwendung in inlinePicture.set({ ... }).

Word.Interfaces.ListCollectionData

Eine Schnittstelle, die die durch Aufrufen listCollection.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.ListCollectionUpdateData

Eine Schnittstelle zum Aktualisieren von Daten im ListCollection-Objekt zur Verwendung in listCollection.set({ ... }).

Word.Interfaces.ListData

Eine Schnittstelle, die die durch Aufrufen list.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.ListItemData

Eine Schnittstelle, die die durch Aufrufen listItem.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.ListItemUpdateData

Eine Schnittstelle zum Aktualisieren von Daten im ListItem-Objekt zur Verwendung in listItem.set({ ... }).

Word.Interfaces.NoteItemCollectionData

Eine Schnittstelle, die die durch Aufrufen noteItemCollection.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.NoteItemCollectionUpdateData

Eine Schnittstelle zum Aktualisieren von Daten für das NoteItemCollection-Objekt zur Verwendung in noteItemCollection.set({ ... }).

Word.Interfaces.NoteItemData

Eine Schnittstelle, die die durch Aufrufen noteItem.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.NoteItemUpdateData

Eine Schnittstelle zum Aktualisieren von Daten im NoteItem-Objekt zur Verwendung in noteItem.set({ ... }).

Word.Interfaces.ParagraphCollectionData

Eine Schnittstelle, die die durch Aufrufen paragraphCollection.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.ParagraphCollectionLoadOptions

Enthält eine Auflistung von Word. Absatzobjekte.

Word.Interfaces.ParagraphCollectionUpdateData

Eine Schnittstelle zum Aktualisieren von Daten im ParagraphCollection-Objekt zur Verwendung in paragraphCollection.set({ ... }).

Word.Interfaces.ParagraphData

Eine Schnittstelle, die die durch Aufrufen paragraph.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.ParagraphFormatData

Eine Schnittstelle, die die durch Aufrufen paragraphFormat.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.ParagraphFormatUpdateData

Eine Schnittstelle zum Aktualisieren von Daten für das ParagraphFormat-Objekt zur Verwendung in paragraphFormat.set({ ... }).

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 Paragraph-Objekt zur Verwendung in paragraph.set({ ... }).

Word.Interfaces.RangeCollectionData

Eine Schnittstelle, die die durch Aufrufen rangeCollection.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.RangeCollectionLoadOptions

Enthält eine Auflistung von Word. Bereichsobjekte.

Word.Interfaces.RangeCollectionUpdateData

Eine Schnittstelle zum Aktualisieren von Daten für das RangeCollection-Objekt zur Verwendung in rangeCollection.set({ ... }).

Word.Interfaces.RangeData

Eine Schnittstelle, die die durch Aufrufen range.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.RangeLoadOptions

Stellt einen zusammenhängenden Bereich in einem Dokument dar.

Word.Interfaces.RangeUpdateData

Eine Schnittstelle zum Aktualisieren von Daten für das Range-Objekt zur Verwendung in range.set({ ... }).

Word.Interfaces.SearchOptionsData

Eine Schnittstelle, die die durch Aufrufen searchOptions.toJSON()von zurückgegebenen Daten beschreibt.

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 im SearchOptions-Objekt zur Verwendung in searchOptions.set({ ... }).

Word.Interfaces.SectionCollectionData

Eine Schnittstelle, die die durch Aufrufen sectionCollection.toJSON()von zurückgegebenen Daten beschreibt.

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 SectionCollection-Objekt zur Verwendung in sectionCollection.set({ ... }).

Word.Interfaces.SectionData

Eine Schnittstelle, die die durch Aufrufen section.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.SectionLoadOptions

Stellt einen Abschnitt in ein Word-Dokument dar.

Word.Interfaces.SectionUpdateData

Eine Schnittstelle zum Aktualisieren von Daten für das Section-Objekt zur Verwendung in section.set({ ... }).

Word.Interfaces.SettingCollectionData

Eine Schnittstelle, die die durch Aufrufen settingCollection.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.SettingCollectionUpdateData

Eine Schnittstelle zum Aktualisieren von Daten im SettingCollection-Objekt zur Verwendung in settingCollection.set({ ... }).

Word.Interfaces.SettingData

Eine Schnittstelle, die die durch Aufrufen setting.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.SettingUpdateData

Eine Schnittstelle zum Aktualisieren von Daten für das Setting-Objekt zur Verwendung in setting.set({ ... }).

Word.Interfaces.ShadingData

Eine Schnittstelle, die die durch Aufrufen shading.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.ShadingUpdateData

Eine Schnittstelle zum Aktualisieren von Daten für das Shading-Objekt zur Verwendung in shading.set({ ... }).

Word.Interfaces.StyleCollectionData

Eine Schnittstelle, die die durch Aufrufen styleCollection.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.StyleCollectionUpdateData

Eine Schnittstelle zum Aktualisieren von Daten für das StyleCollection-Objekt zur Verwendung in styleCollection.set({ ... }).

Word.Interfaces.StyleData

Eine Schnittstelle, die die durch Aufrufen style.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.StyleUpdateData

Eine Schnittstelle zum Aktualisieren von Daten für das Style-Objekt zur Verwendung in style.set({ ... }).

Word.Interfaces.TableBorderData

Eine Schnittstelle, die die durch Aufrufen tableBorder.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.TableBorderUpdateData

Eine Schnittstelle zum Aktualisieren von Daten für das TableBorder-Objekt zur Verwendung in tableBorder.set({ ... }).

Word.Interfaces.TableCellCollectionData

Eine Schnittstelle, die die durch Aufrufen tableCellCollection.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.TableCellCollectionUpdateData

Eine Schnittstelle zum Aktualisieren von Daten im TableCellCollection-Objekt zur Verwendung in tableCellCollection.set({ ... }).

Word.Interfaces.TableCellData

Eine Schnittstelle, die die durch Aufrufen tableCell.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.TableCellUpdateData

Eine Schnittstelle zum Aktualisieren von Daten für das TableCell-Objekt zur Verwendung in tableCell.set({ ... }).

Word.Interfaces.TableCollectionData

Eine Schnittstelle, die die durch Aufrufen tableCollection.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.TableCollectionUpdateData

Eine Schnittstelle zum Aktualisieren von Daten im TableCollection-Objekt zur Verwendung in tableCollection.set({ ... }).

Word.Interfaces.TableData

Eine Schnittstelle, die die durch Aufrufen table.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.TableRowCollectionData

Eine Schnittstelle, die die durch Aufrufen tableRowCollection.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.TableRowCollectionUpdateData

Eine Schnittstelle zum Aktualisieren von Daten im TableRowCollection-Objekt zur Verwendung in tableRowCollection.set({ ... }).

Word.Interfaces.TableRowData

Eine Schnittstelle, die die durch Aufrufen tableRow.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.TableRowUpdateData

Eine Schnittstelle zum Aktualisieren von Daten für das TableRow-Objekt zur Verwendung in tableRow.set({ ... }).

Word.Interfaces.TableStyleData

Eine Schnittstelle, die die durch Aufrufen tableStyle.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.TableStyleUpdateData

Eine Schnittstelle zum Aktualisieren von Daten für das TableStyle-Objekt zur Verwendung in tableStyle.set({ ... }).

Word.Interfaces.TableUpdateData

Eine Schnittstelle zum Aktualisieren von Daten für das Table-Objekt zur Verwendung in table.set({ ... }).

Word.Interfaces.TrackedChangeCollectionData

Eine Schnittstelle, die die durch Aufrufen trackedChangeCollection.toJSON()von zurückgegebenen Daten beschreibt.

Word.Interfaces.TrackedChangeCollectionUpdateData

Eine Schnittstelle zum Aktualisieren von Daten im TrackedChangeCollection-Objekt zur Verwendung in trackedChangeCollection.set({ ... }).

Word.Interfaces.TrackedChangeData

Eine Schnittstelle, die die durch Aufrufen trackedChange.toJSON()von zurückgegebenen Daten beschreibt.

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 Document.savean.

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.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.

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.

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.

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

OfficeExtension.ClientObject[]

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, was 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, was 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>