word package

Classes

Word.Body	Represents the body of a document or a section.
Word.ContentControl	Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported.
Word.ContentControlCollection	Contains a collection of Word.ContentControl objects. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported.
Word.Document	The `Document` object is the top level object. A `Document` object contains one or more sections, content controls, and the body that contains the contents of the document.
Word.Font	Represents a font.
Word.InlinePicture	Represents an inline picture.
Word.InlinePictureCollection	Contains a collection of Word.InlinePicture objects.
Word.Paragraph	Represents a single paragraph in a selection, range, content control, or document body.
Word.ParagraphCollection	Contains a collection of Word.Paragraph objects.
Word.Range	Represents a contiguous area in a document.
Word.RangeCollection	Contains a collection of Word.Range objects.
Word.RequestContext	The RequestContext object facilitates requests to the Word application. Since the Office add-in and the Word application run in two different processes, the request context is required to get access to the Word object model from the add-in.
Word.SearchOptions	Specifies the options to be included in a search operation. To learn more about how to use search options in the Word JavaScript APIs, read Use search options to find text in your Word add-in.
Word.Section	Represents a section in a Word document.
Word.SectionCollection	Contains the collection of the document's Word.Section objects.

Interfaces

Word.Interfaces.AnnotationCollectionData	An interface describing the data returned by calling `annotationCollection.toJSON()`.
Word.Interfaces.AnnotationCollectionUpdateData	An interface for updating data on the `AnnotationCollection` object, for use in `annotationCollection.set({ ... })`.
Word.Interfaces.AnnotationData	An interface describing the data returned by calling `annotation.toJSON()`.
Word.Interfaces.ApplicationData	An interface describing the data returned by calling `application.toJSON()`.
Word.Interfaces.ApplicationUpdateData	An interface for updating data on the `Application` object, for use in `application.set({ ... })`.
Word.Interfaces.BibliographyData	An interface describing the data returned by calling `bibliography.toJSON()`.
Word.Interfaces.BibliographyUpdateData	An interface for updating data on the `Bibliography` object, for use in `bibliography.set({ ... })`.
Word.Interfaces.BodyData	An interface describing the data returned by calling `body.toJSON()`.
Word.Interfaces.BodyLoadOptions	Represents the body of a document or a section.
Word.Interfaces.BodyUpdateData	An interface for updating data on the `Body` object, for use in `body.set({ ... })`.
Word.Interfaces.BookmarkCollectionData	An interface describing the data returned by calling `bookmarkCollection.toJSON()`.
Word.Interfaces.BookmarkCollectionUpdateData	An interface for updating data on the `BookmarkCollection` object, for use in `bookmarkCollection.set({ ... })`.
Word.Interfaces.BookmarkData	An interface describing the data returned by calling `bookmark.toJSON()`.
Word.Interfaces.BookmarkUpdateData	An interface for updating data on the `Bookmark` object, for use in `bookmark.set({ ... })`.
Word.Interfaces.BorderCollectionData	An interface describing the data returned by calling `borderCollection.toJSON()`.
Word.Interfaces.BorderCollectionUpdateData	An interface for updating data on the `BorderCollection` object, for use in `borderCollection.set({ ... })`.
Word.Interfaces.BorderData	An interface describing the data returned by calling `border.toJSON()`.
Word.Interfaces.BorderUniversalCollectionData	An interface describing the data returned by calling `borderUniversalCollection.toJSON()`.
Word.Interfaces.BorderUniversalCollectionUpdateData	An interface for updating data on the `BorderUniversalCollection` object, for use in `borderUniversalCollection.set({ ... })`.
Word.Interfaces.BorderUniversalData	An interface describing the data returned by calling `borderUniversal.toJSON()`.
Word.Interfaces.BorderUniversalUpdateData	An interface for updating data on the `BorderUniversal` object, for use in `borderUniversal.set({ ... })`.
Word.Interfaces.BorderUpdateData	An interface for updating data on the `Border` object, for use in `border.set({ ... })`.
Word.Interfaces.BreakCollectionData	An interface describing the data returned by calling `breakCollection.toJSON()`.
Word.Interfaces.BreakCollectionUpdateData	An interface for updating data on the `BreakCollection` object, for use in `breakCollection.set({ ... })`.
Word.Interfaces.BreakData	An interface describing the data returned by calling `break.toJSON()`.
Word.Interfaces.BreakUpdateData	An interface for updating data on the `Break` object, for use in `break.set({ ... })`.
Word.Interfaces.BuildingBlockCategoryData	An interface describing the data returned by calling `buildingBlockCategory.toJSON()`.
Word.Interfaces.BuildingBlockData	An interface describing the data returned by calling `buildingBlock.toJSON()`.
Word.Interfaces.BuildingBlockGalleryContentControlData	An interface describing the data returned by calling `buildingBlockGalleryContentControl.toJSON()`.
Word.Interfaces.BuildingBlockGalleryContentControlUpdateData	An interface for updating data on the `BuildingBlockGalleryContentControl` object, for use in `buildingBlockGalleryContentControl.set({ ... })`.
Word.Interfaces.BuildingBlockTypeItemData	An interface describing the data returned by calling `buildingBlockTypeItem.toJSON()`.
Word.Interfaces.BuildingBlockUpdateData	An interface for updating data on the `BuildingBlock` object, for use in `buildingBlock.set({ ... })`.
Word.Interfaces.CanvasData	An interface describing the data returned by calling `canvas.toJSON()`.
Word.Interfaces.CanvasUpdateData	An interface for updating data on the `Canvas` object, for use in `canvas.set({ ... })`.
Word.Interfaces.CheckboxContentControlData	An interface describing the data returned by calling `checkboxContentControl.toJSON()`.
Word.Interfaces.CheckboxContentControlUpdateData	An interface for updating data on the `CheckboxContentControl` object, for use in `checkboxContentControl.set({ ... })`.
Word.Interfaces.CoauthorCollectionData	An interface describing the data returned by calling `coauthorCollection.toJSON()`.
Word.Interfaces.CoauthorCollectionUpdateData	An interface for updating data on the `CoauthorCollection` object, for use in `coauthorCollection.set({ ... })`.
Word.Interfaces.CoauthorData	An interface describing the data returned by calling `coauthor.toJSON()`.
Word.Interfaces.CoauthoringData	An interface describing the data returned by calling `coauthoring.toJSON()`.
Word.Interfaces.CoauthoringLockCollectionData	An interface describing the data returned by calling `coauthoringLockCollection.toJSON()`.
Word.Interfaces.CoauthoringLockCollectionUpdateData	An interface for updating data on the `CoauthoringLockCollection` object, for use in `coauthoringLockCollection.set({ ... })`.
Word.Interfaces.CoauthoringLockData	An interface describing the data returned by calling `coauthoringLock.toJSON()`.
Word.Interfaces.CoauthoringLockUpdateData	An interface for updating data on the `CoauthoringLock` object, for use in `coauthoringLock.set({ ... })`.
Word.Interfaces.CoauthoringUpdateCollectionData	An interface describing the data returned by calling `coauthoringUpdateCollection.toJSON()`.
Word.Interfaces.CoauthoringUpdateCollectionUpdateData	An interface for updating data on the `CoauthoringUpdateCollection` object, for use in `coauthoringUpdateCollection.set({ ... })`.
Word.Interfaces.CoauthoringUpdateData	An interface describing the data returned by calling `coauthoringUpdate.toJSON()`.
Word.Interfaces.CoauthoringUpdateUpdateData	An interface for updating data on the `CoauthoringUpdate` object, for use in `coauthoringUpdate.set({ ... })`.
Word.Interfaces.CollectionLoadOptions	Provides ways to load properties of only a subset of members of a collection.
Word.Interfaces.ColorFormatData	An interface describing the data returned by calling `colorFormat.toJSON()`.
Word.Interfaces.ColorFormatUpdateData	An interface for updating data on the `ColorFormat` object, for use in `colorFormat.set({ ... })`.
Word.Interfaces.ComboBoxContentControlData	An interface describing the data returned by calling `comboBoxContentControl.toJSON()`.
Word.Interfaces.CommentCollectionData	An interface describing the data returned by calling `commentCollection.toJSON()`.
Word.Interfaces.CommentCollectionUpdateData	An interface for updating data on the `CommentCollection` object, for use in `commentCollection.set({ ... })`.
Word.Interfaces.CommentContentRangeData	An interface describing the data returned by calling `commentContentRange.toJSON()`.
Word.Interfaces.CommentContentRangeUpdateData	An interface for updating data on the `CommentContentRange` object, for use in `commentContentRange.set({ ... })`.
Word.Interfaces.CommentData	An interface describing the data returned by calling `comment.toJSON()`.
Word.Interfaces.CommentReplyCollectionData	An interface describing the data returned by calling `commentReplyCollection.toJSON()`.
Word.Interfaces.CommentReplyCollectionUpdateData	An interface for updating data on the `CommentReplyCollection` object, for use in `commentReplyCollection.set({ ... })`.
Word.Interfaces.CommentReplyData	An interface describing the data returned by calling `commentReply.toJSON()`.
Word.Interfaces.CommentReplyUpdateData	An interface for updating data on the `CommentReply` object, for use in `commentReply.set({ ... })`.
Word.Interfaces.CommentUpdateData	An interface for updating data on the `Comment` object, for use in `comment.set({ ... })`.
Word.Interfaces.ConditionalStyleData	An interface describing the data returned by calling `conditionalStyle.toJSON()`.
Word.Interfaces.ConditionalStyleUpdateData	An interface for updating data on the `ConditionalStyle` object, for use in `conditionalStyle.set({ ... })`.
Word.Interfaces.ConflictCollectionData	An interface describing the data returned by calling `conflictCollection.toJSON()`.
Word.Interfaces.ConflictCollectionUpdateData	An interface for updating data on the `ConflictCollection` object, for use in `conflictCollection.set({ ... })`.
Word.Interfaces.ConflictData	An interface describing the data returned by calling `conflict.toJSON()`.
Word.Interfaces.ConflictUpdateData	An interface for updating data on the `Conflict` object, for use in `conflict.set({ ... })`.
Word.Interfaces.ContentControlCollectionData	An interface describing the data returned by calling `contentControlCollection.toJSON()`.
Word.Interfaces.ContentControlCollectionLoadOptions	Contains a collection of Word.ContentControl objects. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported.
Word.Interfaces.ContentControlCollectionUpdateData	An interface for updating data on the `ContentControlCollection` object, for use in `contentControlCollection.set({ ... })`.
Word.Interfaces.ContentControlData	An interface describing the data returned by calling `contentControl.toJSON()`.
Word.Interfaces.ContentControlListItemCollectionData	An interface describing the data returned by calling `contentControlListItemCollection.toJSON()`.
Word.Interfaces.ContentControlListItemCollectionUpdateData	An interface for updating data on the `ContentControlListItemCollection` object, for use in `contentControlListItemCollection.set({ ... })`.
Word.Interfaces.ContentControlListItemData	An interface describing the data returned by calling `contentControlListItem.toJSON()`.
Word.Interfaces.ContentControlListItemUpdateData	An interface for updating data on the `ContentControlListItem` object, for use in `contentControlListItem.set({ ... })`.
Word.Interfaces.ContentControlLoadOptions	Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported.
Word.Interfaces.ContentControlUpdateData	An interface for updating data on the `ContentControl` object, for use in `contentControl.set({ ... })`.
Word.Interfaces.CritiqueAnnotationData	An interface describing the data returned by calling `critiqueAnnotation.toJSON()`.
Word.Interfaces.CustomPropertyCollectionData	An interface describing the data returned by calling `customPropertyCollection.toJSON()`.
Word.Interfaces.CustomPropertyCollectionUpdateData	An interface for updating data on the `CustomPropertyCollection` object, for use in `customPropertyCollection.set({ ... })`.
Word.Interfaces.CustomPropertyData	An interface describing the data returned by calling `customProperty.toJSON()`.
Word.Interfaces.CustomPropertyUpdateData	An interface for updating data on the `CustomProperty` object, for use in `customProperty.set({ ... })`.
Word.Interfaces.CustomXmlNodeCollectionData	An interface describing the data returned by calling `customXmlNodeCollection.toJSON()`.
Word.Interfaces.CustomXmlNodeCollectionUpdateData	An interface for updating data on the `CustomXmlNodeCollection` object, for use in `customXmlNodeCollection.set({ ... })`.
Word.Interfaces.CustomXmlNodeData	An interface describing the data returned by calling `customXmlNode.toJSON()`.
Word.Interfaces.CustomXmlNodeUpdateData	An interface for updating data on the `CustomXmlNode` object, for use in `customXmlNode.set({ ... })`.
Word.Interfaces.CustomXmlPartCollectionData	An interface describing the data returned by calling `customXmlPartCollection.toJSON()`.
Word.Interfaces.CustomXmlPartCollectionUpdateData	An interface for updating data on the `CustomXmlPartCollection` object, for use in `customXmlPartCollection.set({ ... })`.
Word.Interfaces.CustomXmlPartData	An interface describing the data returned by calling `customXmlPart.toJSON()`.
Word.Interfaces.CustomXmlPartScopedCollectionData	An interface describing the data returned by calling `customXmlPartScopedCollection.toJSON()`.
Word.Interfaces.CustomXmlPartScopedCollectionUpdateData	An interface for updating data on the `CustomXmlPartScopedCollection` object, for use in `customXmlPartScopedCollection.set({ ... })`.
Word.Interfaces.CustomXmlPartUpdateData	An interface for updating data on the `CustomXmlPart` object, for use in `customXmlPart.set({ ... })`.
Word.Interfaces.CustomXmlPrefixMappingCollectionData	An interface describing the data returned by calling `customXmlPrefixMappingCollection.toJSON()`.
Word.Interfaces.CustomXmlPrefixMappingCollectionUpdateData	An interface for updating data on the `CustomXmlPrefixMappingCollection` object, for use in `customXmlPrefixMappingCollection.set({ ... })`.
Word.Interfaces.CustomXmlPrefixMappingData	An interface describing the data returned by calling `customXmlPrefixMapping.toJSON()`.
Word.Interfaces.CustomXmlSchemaCollectionData	An interface describing the data returned by calling `customXmlSchemaCollection.toJSON()`.
Word.Interfaces.CustomXmlSchemaCollectionUpdateData	An interface for updating data on the `CustomXmlSchemaCollection` object, for use in `customXmlSchemaCollection.set({ ... })`.
Word.Interfaces.CustomXmlSchemaData	An interface describing the data returned by calling `customXmlSchema.toJSON()`.
Word.Interfaces.DatePickerContentControlData	An interface describing the data returned by calling `datePickerContentControl.toJSON()`.
Word.Interfaces.DatePickerContentControlUpdateData	An interface for updating data on the `DatePickerContentControl` object, for use in `datePickerContentControl.set({ ... })`.
Word.Interfaces.DocumentCreatedData	An interface describing the data returned by calling `documentCreated.toJSON()`.
Word.Interfaces.DocumentCreatedUpdateData	An interface for updating data on the `DocumentCreated` object, for use in `documentCreated.set({ ... })`.
Word.Interfaces.DocumentData	An interface describing the data returned by calling `document.toJSON()`.
Word.Interfaces.DocumentLibraryVersionCollectionData	An interface describing the data returned by calling `documentLibraryVersionCollection.toJSON()`.
Word.Interfaces.DocumentLibraryVersionCollectionUpdateData	An interface for updating data on the `DocumentLibraryVersionCollection` object, for use in `documentLibraryVersionCollection.set({ ... })`.
Word.Interfaces.DocumentLibraryVersionData	An interface describing the data returned by calling `documentLibraryVersion.toJSON()`.
Word.Interfaces.DocumentLoadOptions	The `Document` object is the top level object. A `Document` object contains one or more sections, content controls, and the body that contains the contents of the document.
Word.Interfaces.DocumentPropertiesData	An interface describing the data returned by calling `documentProperties.toJSON()`.
Word.Interfaces.DocumentPropertiesUpdateData	An interface for updating data on the `DocumentProperties` object, for use in `documentProperties.set({ ... })`.
Word.Interfaces.DocumentUpdateData	An interface for updating data on the `Document` object, for use in `document.set({ ... })`.
Word.Interfaces.DropCapData	An interface describing the data returned by calling `dropCap.toJSON()`.
Word.Interfaces.DropDownListContentControlData	An interface describing the data returned by calling `dropDownListContentControl.toJSON()`.
Word.Interfaces.EditorData	An interface describing the data returned by calling `editor.toJSON()`.
Word.Interfaces.EditorUpdateData	An interface for updating data on the `Editor` object, for use in `editor.set({ ... })`.
Word.Interfaces.FieldCollectionData	An interface describing the data returned by calling `fieldCollection.toJSON()`.
Word.Interfaces.FieldCollectionUpdateData	An interface for updating data on the `FieldCollection` object, for use in `fieldCollection.set({ ... })`.
Word.Interfaces.FieldData	An interface describing the data returned by calling `field.toJSON()`.
Word.Interfaces.FieldUpdateData	An interface for updating data on the `Field` object, for use in `field.set({ ... })`.
Word.Interfaces.FillFormatData	An interface describing the data returned by calling `fillFormat.toJSON()`.
Word.Interfaces.FillFormatUpdateData	An interface for updating data on the `FillFormat` object, for use in `fillFormat.set({ ... })`.
Word.Interfaces.FontData	An interface describing the data returned by calling `font.toJSON()`.
Word.Interfaces.FontLoadOptions	Represents a font.
Word.Interfaces.FontUpdateData	An interface for updating data on the `Font` object, for use in `font.set({ ... })`.
Word.Interfaces.FrameCollectionData	An interface describing the data returned by calling `frameCollection.toJSON()`.
Word.Interfaces.FrameCollectionUpdateData	An interface for updating data on the `FrameCollection` object, for use in `frameCollection.set({ ... })`.
Word.Interfaces.FrameData	An interface describing the data returned by calling `frame.toJSON()`.
Word.Interfaces.FrameUpdateData	An interface for updating data on the `Frame` object, for use in `frame.set({ ... })`.
Word.Interfaces.GlowFormatData	An interface describing the data returned by calling `glowFormat.toJSON()`.
Word.Interfaces.GlowFormatUpdateData	An interface for updating data on the `GlowFormat` object, for use in `glowFormat.set({ ... })`.
Word.Interfaces.GroupContentControlData	An interface describing the data returned by calling `groupContentControl.toJSON()`.
Word.Interfaces.GroupContentControlUpdateData	An interface for updating data on the `GroupContentControl` object, for use in `groupContentControl.set({ ... })`.
Word.Interfaces.HeadingStyleCollectionData	An interface describing the data returned by calling `headingStyleCollection.toJSON()`.
Word.Interfaces.HeadingStyleCollectionUpdateData	An interface for updating data on the `HeadingStyleCollection` object, for use in `headingStyleCollection.set({ ... })`.
Word.Interfaces.HeadingStyleData	An interface describing the data returned by calling `headingStyle.toJSON()`.
Word.Interfaces.HeadingStyleUpdateData	An interface for updating data on the `HeadingStyle` object, for use in `headingStyle.set({ ... })`.
Word.Interfaces.HtmlDivisionCollectionData	An interface describing the data returned by calling `htmlDivisionCollection.toJSON()`.
Word.Interfaces.HtmlDivisionCollectionUpdateData	An interface for updating data on the `HtmlDivisionCollection` object, for use in `htmlDivisionCollection.set({ ... })`.
Word.Interfaces.HtmlDivisionData	An interface describing the data returned by calling `htmlDivision.toJSON()`.
Word.Interfaces.HtmlDivisionUpdateData	An interface for updating data on the `HtmlDivision` object, for use in `htmlDivision.set({ ... })`.
Word.Interfaces.HyperlinkCollectionData	An interface describing the data returned by calling `hyperlinkCollection.toJSON()`.
Word.Interfaces.HyperlinkCollectionUpdateData	An interface for updating data on the `HyperlinkCollection` object, for use in `hyperlinkCollection.set({ ... })`.
Word.Interfaces.HyperlinkData	An interface describing the data returned by calling `hyperlink.toJSON()`.
Word.Interfaces.HyperlinkUpdateData	An interface for updating data on the `Hyperlink` object, for use in `hyperlink.set({ ... })`.
Word.Interfaces.IndexCollectionData	An interface describing the data returned by calling `indexCollection.toJSON()`.
Word.Interfaces.IndexCollectionUpdateData	An interface for updating data on the `IndexCollection` object, for use in `indexCollection.set({ ... })`.
Word.Interfaces.IndexData	An interface describing the data returned by calling `index.toJSON()`.
Word.Interfaces.IndexUpdateData	An interface for updating data on the `Index` object, for use in `index.set({ ... })`.
Word.Interfaces.InlinePictureCollectionData	An interface describing the data returned by calling `inlinePictureCollection.toJSON()`.
Word.Interfaces.InlinePictureCollectionLoadOptions	Contains a collection of Word.InlinePicture objects.
Word.Interfaces.InlinePictureCollectionUpdateData	An interface for updating data on the `InlinePictureCollection` object, for use in `inlinePictureCollection.set({ ... })`.
Word.Interfaces.InlinePictureData	An interface describing the data returned by calling `inlinePicture.toJSON()`.
Word.Interfaces.InlinePictureLoadOptions	Represents an inline picture.
Word.Interfaces.InlinePictureUpdateData	An interface for updating data on the `InlinePicture` object, for use in `inlinePicture.set({ ... })`.
Word.Interfaces.LineFormatData	An interface describing the data returned by calling `lineFormat.toJSON()`.
Word.Interfaces.LineFormatUpdateData	An interface for updating data on the `LineFormat` object, for use in `lineFormat.set({ ... })`.
Word.Interfaces.LineNumberingData	An interface describing the data returned by calling `lineNumbering.toJSON()`.
Word.Interfaces.LineNumberingUpdateData	An interface for updating data on the `LineNumbering` object, for use in `lineNumbering.set({ ... })`.
Word.Interfaces.LinkFormatData	An interface describing the data returned by calling `linkFormat.toJSON()`.
Word.Interfaces.LinkFormatUpdateData	An interface for updating data on the `LinkFormat` object, for use in `linkFormat.set({ ... })`.
Word.Interfaces.ListCollectionData	An interface describing the data returned by calling `listCollection.toJSON()`.
Word.Interfaces.ListCollectionUpdateData	An interface for updating data on the `ListCollection` object, for use in `listCollection.set({ ... })`.
Word.Interfaces.ListData	An interface describing the data returned by calling `list.toJSON()`.
Word.Interfaces.ListFormatData	An interface describing the data returned by calling `listFormat.toJSON()`.
Word.Interfaces.ListFormatUpdateData	An interface for updating data on the `ListFormat` object, for use in `listFormat.set({ ... })`.
Word.Interfaces.ListItemData	An interface describing the data returned by calling `listItem.toJSON()`.
Word.Interfaces.ListItemUpdateData	An interface for updating data on the `ListItem` object, for use in `listItem.set({ ... })`.
Word.Interfaces.ListLevelCollectionData	An interface describing the data returned by calling `listLevelCollection.toJSON()`.
Word.Interfaces.ListLevelCollectionUpdateData	An interface for updating data on the `ListLevelCollection` object, for use in `listLevelCollection.set({ ... })`.
Word.Interfaces.ListLevelData	An interface describing the data returned by calling `listLevel.toJSON()`.
Word.Interfaces.ListLevelUpdateData	An interface for updating data on the `ListLevel` object, for use in `listLevel.set({ ... })`.
Word.Interfaces.ListTemplateCollectionData	An interface describing the data returned by calling `listTemplateCollection.toJSON()`.
Word.Interfaces.ListTemplateCollectionUpdateData	An interface for updating data on the `ListTemplateCollection` object, for use in `listTemplateCollection.set({ ... })`.
Word.Interfaces.ListTemplateData	An interface describing the data returned by calling `listTemplate.toJSON()`.
Word.Interfaces.ListTemplateGalleryCollectionData	An interface describing the data returned by calling `listTemplateGalleryCollection.toJSON()`.
Word.Interfaces.ListTemplateGalleryCollectionUpdateData	An interface for updating data on the `ListTemplateGalleryCollection` object, for use in `listTemplateGalleryCollection.set({ ... })`.
Word.Interfaces.ListTemplateGalleryData	An interface describing the data returned by calling `listTemplateGallery.toJSON()`.
Word.Interfaces.ListTemplateUpdateData	An interface for updating data on the `ListTemplate` object, for use in `listTemplate.set({ ... })`.
Word.Interfaces.NoteItemCollectionData	An interface describing the data returned by calling `noteItemCollection.toJSON()`.
Word.Interfaces.NoteItemCollectionUpdateData	An interface for updating data on the `NoteItemCollection` object, for use in `noteItemCollection.set({ ... })`.
Word.Interfaces.NoteItemData	An interface describing the data returned by calling `noteItem.toJSON()`.
Word.Interfaces.NoteItemUpdateData	An interface for updating data on the `NoteItem` object, for use in `noteItem.set({ ... })`.
Word.Interfaces.OleFormatData	An interface describing the data returned by calling `oleFormat.toJSON()`.
Word.Interfaces.OleFormatUpdateData	An interface for updating data on the `OleFormat` object, for use in `oleFormat.set({ ... })`.
Word.Interfaces.PageCollectionData	An interface describing the data returned by calling `pageCollection.toJSON()`.
Word.Interfaces.PageCollectionUpdateData	An interface for updating data on the `PageCollection` object, for use in `pageCollection.set({ ... })`.
Word.Interfaces.PageData	An interface describing the data returned by calling `page.toJSON()`.
Word.Interfaces.PageSetupData	An interface describing the data returned by calling `pageSetup.toJSON()`.
Word.Interfaces.PageSetupUpdateData	An interface for updating data on the `PageSetup` object, for use in `pageSetup.set({ ... })`.
Word.Interfaces.PaneCollectionData	An interface describing the data returned by calling `paneCollection.toJSON()`.
Word.Interfaces.PaneCollectionUpdateData	An interface for updating data on the `PaneCollection` object, for use in `paneCollection.set({ ... })`.
Word.Interfaces.PaneData	An interface describing the data returned by calling `pane.toJSON()`.
Word.Interfaces.ParagraphCollectionData	An interface describing the data returned by calling `paragraphCollection.toJSON()`.
Word.Interfaces.ParagraphCollectionLoadOptions	Contains a collection of Word.Paragraph objects.
Word.Interfaces.ParagraphCollectionUpdateData	An interface for updating data on the `ParagraphCollection` object, for use in `paragraphCollection.set({ ... })`.
Word.Interfaces.ParagraphData	An interface describing the data returned by calling `paragraph.toJSON()`.
Word.Interfaces.ParagraphFormatData	An interface describing the data returned by calling `paragraphFormat.toJSON()`.
Word.Interfaces.ParagraphFormatUpdateData	An interface for updating data on the `ParagraphFormat` object, for use in `paragraphFormat.set({ ... })`.
Word.Interfaces.ParagraphLoadOptions	Represents a single paragraph in a selection, range, content control, or document body.
Word.Interfaces.ParagraphUpdateData	An interface for updating data on the `Paragraph` object, for use in `paragraph.set({ ... })`.
Word.Interfaces.PictureContentControlData	An interface describing the data returned by calling `pictureContentControl.toJSON()`.
Word.Interfaces.PictureContentControlUpdateData	An interface for updating data on the `PictureContentControl` object, for use in `pictureContentControl.set({ ... })`.
Word.Interfaces.RangeCollectionData	An interface describing the data returned by calling `rangeCollection.toJSON()`.
Word.Interfaces.RangeCollectionLoadOptions	Contains a collection of Word.Range objects.
Word.Interfaces.RangeCollectionUpdateData	An interface for updating data on the `RangeCollection` object, for use in `rangeCollection.set({ ... })`.
Word.Interfaces.RangeData	An interface describing the data returned by calling `range.toJSON()`.
Word.Interfaces.RangeLoadOptions	Represents a contiguous area in a document.
Word.Interfaces.RangeScopedCollectionData	An interface describing the data returned by calling `rangeScopedCollection.toJSON()`.
Word.Interfaces.RangeScopedCollectionUpdateData	An interface for updating data on the `RangeScopedCollection` object, for use in `rangeScopedCollection.set({ ... })`.
Word.Interfaces.RangeUpdateData	An interface for updating data on the `Range` object, for use in `range.set({ ... })`.
Word.Interfaces.ReadabilityStatisticCollectionData	An interface describing the data returned by calling `readabilityStatisticCollection.toJSON()`.
Word.Interfaces.ReadabilityStatisticCollectionUpdateData	An interface for updating data on the `ReadabilityStatisticCollection` object, for use in `readabilityStatisticCollection.set({ ... })`.
Word.Interfaces.ReadabilityStatisticData	An interface describing the data returned by calling `readabilityStatistic.toJSON()`.
Word.Interfaces.ReflectionFormatData	An interface describing the data returned by calling `reflectionFormat.toJSON()`.
Word.Interfaces.ReflectionFormatUpdateData	An interface for updating data on the `ReflectionFormat` object, for use in `reflectionFormat.set({ ... })`.
Word.Interfaces.RepeatingSectionContentControlData	An interface describing the data returned by calling `repeatingSectionContentControl.toJSON()`.
Word.Interfaces.RepeatingSectionContentControlUpdateData	An interface for updating data on the `RepeatingSectionContentControl` object, for use in `repeatingSectionContentControl.set({ ... })`.
Word.Interfaces.RepeatingSectionItemData	An interface describing the data returned by calling `repeatingSectionItem.toJSON()`.
Word.Interfaces.RepeatingSectionItemUpdateData	An interface for updating data on the `RepeatingSectionItem` object, for use in `repeatingSectionItem.set({ ... })`.
Word.Interfaces.ReviewerCollectionData	An interface describing the data returned by calling `reviewerCollection.toJSON()`.
Word.Interfaces.ReviewerCollectionUpdateData	An interface for updating data on the `ReviewerCollection` object, for use in `reviewerCollection.set({ ... })`.
Word.Interfaces.ReviewerData	An interface describing the data returned by calling `reviewer.toJSON()`.
Word.Interfaces.ReviewerUpdateData	An interface for updating data on the `Reviewer` object, for use in `reviewer.set({ ... })`.
Word.Interfaces.RevisionCollectionData	An interface describing the data returned by calling `revisionCollection.toJSON()`.
Word.Interfaces.RevisionCollectionUpdateData	An interface for updating data on the `RevisionCollection` object, for use in `revisionCollection.set({ ... })`.
Word.Interfaces.RevisionData	An interface describing the data returned by calling `revision.toJSON()`.
Word.Interfaces.RevisionsFilterData	An interface describing the data returned by calling `revisionsFilter.toJSON()`.
Word.Interfaces.RevisionsFilterUpdateData	An interface for updating data on the `RevisionsFilter` object, for use in `revisionsFilter.set({ ... })`.
Word.Interfaces.RevisionUpdateData	An interface for updating data on the `Revision` object, for use in `revision.set({ ... })`.
Word.Interfaces.SearchOptionsData	An interface describing the data returned by calling `searchOptions.toJSON()`.
Word.Interfaces.SearchOptionsLoadOptions	Specifies the options to be included in a search operation. To learn more about how to use search options in the Word JavaScript APIs, read Use search options to find text in your Word add-in.
Word.Interfaces.SearchOptionsUpdateData	An interface for updating data on the `SearchOptions` object, for use in `searchOptions.set({ ... })`.
Word.Interfaces.SectionCollectionData	An interface describing the data returned by calling `sectionCollection.toJSON()`.
Word.Interfaces.SectionCollectionLoadOptions	Contains the collection of the document's Word.Section objects.
Word.Interfaces.SectionCollectionUpdateData	An interface for updating data on the `SectionCollection` object, for use in `sectionCollection.set({ ... })`.
Word.Interfaces.SectionData	An interface describing the data returned by calling `section.toJSON()`.
Word.Interfaces.SectionLoadOptions	Represents a section in a Word document.
Word.Interfaces.SectionUpdateData	An interface for updating data on the `Section` object, for use in `section.set({ ... })`.
Word.Interfaces.SelectionData	An interface describing the data returned by calling `selection.toJSON()`.
Word.Interfaces.SelectionUpdateData	An interface for updating data on the `Selection` object, for use in `selection.set({ ... })`.
Word.Interfaces.SettingCollectionData	An interface describing the data returned by calling `settingCollection.toJSON()`.
Word.Interfaces.SettingCollectionUpdateData	An interface for updating data on the `SettingCollection` object, for use in `settingCollection.set({ ... })`.
Word.Interfaces.SettingData	An interface describing the data returned by calling `setting.toJSON()`.
Word.Interfaces.SettingUpdateData	An interface for updating data on the `Setting` object, for use in `setting.set({ ... })`.
Word.Interfaces.ShadingData	An interface describing the data returned by calling `shading.toJSON()`.
Word.Interfaces.ShadingUniversalData	An interface describing the data returned by calling `shadingUniversal.toJSON()`.
Word.Interfaces.ShadingUniversalUpdateData	An interface for updating data on the `ShadingUniversal` object, for use in `shadingUniversal.set({ ... })`.
Word.Interfaces.ShadingUpdateData	An interface for updating data on the `Shading` object, for use in `shading.set({ ... })`.
Word.Interfaces.ShadowFormatData	An interface describing the data returned by calling `shadowFormat.toJSON()`.
Word.Interfaces.ShadowFormatUpdateData	An interface for updating data on the `ShadowFormat` object, for use in `shadowFormat.set({ ... })`.
Word.Interfaces.ShapeCollectionData	An interface describing the data returned by calling `shapeCollection.toJSON()`.
Word.Interfaces.ShapeCollectionUpdateData	An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`.
Word.Interfaces.ShapeData	An interface describing the data returned by calling `shape.toJSON()`.
Word.Interfaces.ShapeFillData	An interface describing the data returned by calling `shapeFill.toJSON()`.
Word.Interfaces.ShapeFillUpdateData	An interface for updating data on the `ShapeFill` object, for use in `shapeFill.set({ ... })`.
Word.Interfaces.ShapeGroupData	An interface describing the data returned by calling `shapeGroup.toJSON()`.
Word.Interfaces.ShapeGroupUpdateData	An interface for updating data on the `ShapeGroup` object, for use in `shapeGroup.set({ ... })`.
Word.Interfaces.ShapeTextWrapData	An interface describing the data returned by calling `shapeTextWrap.toJSON()`.
Word.Interfaces.ShapeTextWrapUpdateData	An interface for updating data on the `ShapeTextWrap` object, for use in `shapeTextWrap.set({ ... })`.
Word.Interfaces.ShapeUpdateData	An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`.
Word.Interfaces.SourceCollectionData	An interface describing the data returned by calling `sourceCollection.toJSON()`.
Word.Interfaces.SourceCollectionUpdateData	An interface for updating data on the `SourceCollection` object, for use in `sourceCollection.set({ ... })`.
Word.Interfaces.SourceData	An interface describing the data returned by calling `source.toJSON()`.
Word.Interfaces.StyleCollectionData	An interface describing the data returned by calling `styleCollection.toJSON()`.
Word.Interfaces.StyleCollectionUpdateData	An interface for updating data on the `StyleCollection` object, for use in `styleCollection.set({ ... })`.
Word.Interfaces.StyleData	An interface describing the data returned by calling `style.toJSON()`.
Word.Interfaces.StyleUpdateData	An interface for updating data on the `Style` object, for use in `style.set({ ... })`.
Word.Interfaces.TableBorderData	An interface describing the data returned by calling `tableBorder.toJSON()`.
Word.Interfaces.TableBorderUpdateData	An interface for updating data on the `TableBorder` object, for use in `tableBorder.set({ ... })`.
Word.Interfaces.TableCellCollectionData	An interface describing the data returned by calling `tableCellCollection.toJSON()`.
Word.Interfaces.TableCellCollectionUpdateData	An interface for updating data on the `TableCellCollection` object, for use in `tableCellCollection.set({ ... })`.
Word.Interfaces.TableCellData	An interface describing the data returned by calling `tableCell.toJSON()`.
Word.Interfaces.TableCellUpdateData	An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`.
Word.Interfaces.TableCollectionData	An interface describing the data returned by calling `tableCollection.toJSON()`.
Word.Interfaces.TableCollectionUpdateData	An interface for updating data on the `TableCollection` object, for use in `tableCollection.set({ ... })`.
Word.Interfaces.TableColumnCollectionData	An interface describing the data returned by calling `tableColumnCollection.toJSON()`.
Word.Interfaces.TableColumnCollectionUpdateData	An interface for updating data on the `TableColumnCollection` object, for use in `tableColumnCollection.set({ ... })`.
Word.Interfaces.TableColumnData	An interface describing the data returned by calling `tableColumn.toJSON()`.
Word.Interfaces.TableColumnUpdateData	An interface for updating data on the `TableColumn` object, for use in `tableColumn.set({ ... })`.
Word.Interfaces.TableData	An interface describing the data returned by calling `table.toJSON()`.
Word.Interfaces.TableOfAuthoritiesCategoryCollectionData	An interface describing the data returned by calling `tableOfAuthoritiesCategoryCollection.toJSON()`.
Word.Interfaces.TableOfAuthoritiesCategoryCollectionUpdateData	An interface for updating data on the `TableOfAuthoritiesCategoryCollection` object, for use in `tableOfAuthoritiesCategoryCollection.set({ ... })`.
Word.Interfaces.TableOfAuthoritiesCategoryData	An interface describing the data returned by calling `tableOfAuthoritiesCategory.toJSON()`.
Word.Interfaces.TableOfAuthoritiesCollectionData	An interface describing the data returned by calling `tableOfAuthoritiesCollection.toJSON()`.
Word.Interfaces.TableOfAuthoritiesCollectionUpdateData	An interface for updating data on the `TableOfAuthoritiesCollection` object, for use in `tableOfAuthoritiesCollection.set({ ... })`.
Word.Interfaces.TableOfAuthoritiesData	An interface describing the data returned by calling `tableOfAuthorities.toJSON()`.
Word.Interfaces.TableOfAuthoritiesUpdateData	An interface for updating data on the `TableOfAuthorities` object, for use in `tableOfAuthorities.set({ ... })`.
Word.Interfaces.TableOfContentsCollectionData	An interface describing the data returned by calling `tableOfContentsCollection.toJSON()`.
Word.Interfaces.TableOfContentsCollectionUpdateData	An interface for updating data on the `TableOfContentsCollection` object, for use in `tableOfContentsCollection.set({ ... })`.
Word.Interfaces.TableOfContentsData	An interface describing the data returned by calling `tableOfContents.toJSON()`.
Word.Interfaces.TableOfContentsUpdateData	An interface for updating data on the `TableOfContents` object, for use in `tableOfContents.set({ ... })`.
Word.Interfaces.TableOfFiguresCollectionData	An interface describing the data returned by calling `tableOfFiguresCollection.toJSON()`.
Word.Interfaces.TableOfFiguresCollectionUpdateData	An interface for updating data on the `TableOfFiguresCollection` object, for use in `tableOfFiguresCollection.set({ ... })`.
Word.Interfaces.TableOfFiguresData	An interface describing the data returned by calling `tableOfFigures.toJSON()`.
Word.Interfaces.TableOfFiguresUpdateData	An interface for updating data on the `TableOfFigures` object, for use in `tableOfFigures.set({ ... })`.
Word.Interfaces.TableRowCollectionData	An interface describing the data returned by calling `tableRowCollection.toJSON()`.
Word.Interfaces.TableRowCollectionUpdateData	An interface for updating data on the `TableRowCollection` object, for use in `tableRowCollection.set({ ... })`.
Word.Interfaces.TableRowData	An interface describing the data returned by calling `tableRow.toJSON()`.
Word.Interfaces.TableRowUpdateData	An interface for updating data on the `TableRow` object, for use in `tableRow.set({ ... })`.
Word.Interfaces.TableStyleData	An interface describing the data returned by calling `tableStyle.toJSON()`.
Word.Interfaces.TableStyleUpdateData	An interface for updating data on the `TableStyle` object, for use in `tableStyle.set({ ... })`.
Word.Interfaces.TableUpdateData	An interface for updating data on the `Table` object, for use in `table.set({ ... })`.
Word.Interfaces.TabStopCollectionData	An interface describing the data returned by calling `tabStopCollection.toJSON()`.
Word.Interfaces.TabStopCollectionUpdateData	An interface for updating data on the `TabStopCollection` object, for use in `tabStopCollection.set({ ... })`.
Word.Interfaces.TabStopData	An interface describing the data returned by calling `tabStop.toJSON()`.
Word.Interfaces.TemplateCollectionData	An interface describing the data returned by calling `templateCollection.toJSON()`.
Word.Interfaces.TemplateCollectionUpdateData	An interface for updating data on the `TemplateCollection` object, for use in `templateCollection.set({ ... })`.
Word.Interfaces.TemplateData	An interface describing the data returned by calling `template.toJSON()`.
Word.Interfaces.TemplateUpdateData	An interface for updating data on the `Template` object, for use in `template.set({ ... })`.
Word.Interfaces.TextColumnCollectionData	An interface describing the data returned by calling `textColumnCollection.toJSON()`.
Word.Interfaces.TextColumnCollectionUpdateData	An interface for updating data on the `TextColumnCollection` object, for use in `textColumnCollection.set({ ... })`.
Word.Interfaces.TextColumnData	An interface describing the data returned by calling `textColumn.toJSON()`.
Word.Interfaces.TextColumnUpdateData	An interface for updating data on the `TextColumn` object, for use in `textColumn.set({ ... })`.
Word.Interfaces.TextFrameData	An interface describing the data returned by calling `textFrame.toJSON()`.
Word.Interfaces.TextFrameUpdateData	An interface for updating data on the `TextFrame` object, for use in `textFrame.set({ ... })`.
Word.Interfaces.ThreeDimensionalFormatData	An interface describing the data returned by calling `threeDimensionalFormat.toJSON()`.
Word.Interfaces.ThreeDimensionalFormatUpdateData	An interface for updating data on the `ThreeDimensionalFormat` object, for use in `threeDimensionalFormat.set({ ... })`.
Word.Interfaces.TrackedChangeCollectionData	An interface describing the data returned by calling `trackedChangeCollection.toJSON()`.
Word.Interfaces.TrackedChangeCollectionUpdateData	An interface for updating data on the `TrackedChangeCollection` object, for use in `trackedChangeCollection.set({ ... })`.
Word.Interfaces.TrackedChangeData	An interface describing the data returned by calling `trackedChange.toJSON()`.
Word.Interfaces.ViewData	An interface describing the data returned by calling `view.toJSON()`.
Word.Interfaces.ViewUpdateData	An interface for updating data on the `View` object, for use in `view.set({ ... })`.
Word.Interfaces.WebSettingsData	An interface describing the data returned by calling `webSettings.toJSON()`.
Word.Interfaces.WebSettingsUpdateData	An interface for updating data on the `WebSettings` object, for use in `webSettings.set({ ... })`.
Word.Interfaces.WindowCollectionData	An interface describing the data returned by calling `windowCollection.toJSON()`.
Word.Interfaces.WindowCollectionUpdateData	An interface for updating data on the `WindowCollection` object, for use in `windowCollection.set({ ... })`.
Word.Interfaces.WindowData	An interface describing the data returned by calling `window.toJSON()`.
Word.Interfaces.WindowUpdateData	An interface for updating data on the `Window` object, for use in `window.set({ ... })`.
Word.Interfaces.XmlMappingData	An interface describing the data returned by calling `xmlMapping.toJSON()`.
Word.Interfaces.XmlMappingUpdateData	An interface for updating data on the `XmlMapping` object, for use in `xmlMapping.set({ ... })`.
Word.Interfaces.XmlNodeCollectionData	An interface describing the data returned by calling `xmlNodeCollection.toJSON()`.
Word.Interfaces.XmlNodeCollectionUpdateData	An interface for updating data on the `XmlNodeCollection` object, for use in `xmlNodeCollection.set({ ... })`.
Word.Interfaces.XmlNodeData	An interface describing the data returned by calling `xmlNode.toJSON()`.
Word.Interfaces.XmlNodeUpdateData	An interface for updating data on the `XmlNode` object, for use in `xmlNode.set({ ... })`.

Enums

Word.Alignment	Represents the horizontal alignment of text.
Word.BreakType	Specifies the form of a break.
Word.ContentControlAppearance	Represents the content control appearance.
Word.ContentControlType	Specifies supported content control types and subtypes.
Word.ErrorCodes
Word.HeaderFooterType	Represents the type of header or footer.
Word.InsertLocation	Represents the insertion location type.
Word.SaveBehavior	Specifies the save behavior for `Document.save`.
Word.SelectionMode	Represents where the cursor (insertion point) is set in the document after a selection.
Word.UnderlineType	Represents the supported styles for underline format.

Functions

Word.run(objects, batch)	Executes a batch script that performs actions on the Word object model, using the RequestContext of previously created API objects.
Word.run(object, batch)	Executes a batch script that performs actions on the Word object model, using the RequestContext of a previously created API object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.
Word.run(batch)	Executes a batch script that performs actions on the Word object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.

Function Details

Word.run(objects, batch)

Executes a batch script that performs actions on the Word object model, using the RequestContext of previously created API objects.

export function run<T>(objects: OfficeExtension.ClientObject[], batch: (context: Word.RequestContext) => Promise<T>): Promise<T>;

Parameters

objects: OfficeExtension.ClientObject[]

An array of previously created API objects. The array will be validated to make sure that all of the objects share the same context. The batch will use this shared RequestContext, which means that any changes applied to these objects will be picked up by context.sync().

batch: (context: Word.RequestContext) => Promise<T>

A function that takes in a RequestContext and returns a promise (typically, just the result of context.sync()). The context parameter facilitates requests to the Word application. Since the Office add-in and the Word application run in two different processes, the RequestContext is required to get access to the Word object model from the add-in.

Returns

Promise<T>

Examples

// *.run methods automatically create an OfficeExtension.ClientRequestContext
// object to work with the Office file.
await Word.run(async (context) => {
    const document = context.document;
    // Interact with the Word document...
});

Word.run(object, batch)

Executes a batch script that performs actions on the Word object model, using the RequestContext of a previously created API object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.

export function run<T>(object: OfficeExtension.ClientObject, batch: (context: Word.RequestContext) => Promise<T>): Promise<T>;

Parameters

object: OfficeExtension.ClientObject

A previously created API object. The batch will use the same RequestContext as the passed-in object, which means that any changes applied to the object will be picked up by context.sync().

batch: (context: Word.RequestContext) => Promise<T>

Returns

Promise<T>

Word.run(batch)

Executes a batch script that performs actions on the Word object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.

export function run<T>(batch: (context: Word.RequestContext) => Promise<T>): Promise<T>;

Parameters

batch: (context: Word.RequestContext) => Promise<T>

Returns

Promise<T>

Feedback

Was this page helpful?

Share via

word package

Classes

Interfaces

Enums

Functions

Function Details

Word.run(objects, batch)

Parameters

Returns

Examples

Word.run(object, batch)

Parameters

Returns

Word.run(batch)

Parameters

Returns

Feedback