word package

Represents the application object.

Represents the body of a document or a section.

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, and checkbox content controls are supported.

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 and plain text content controls are supported.

Represents a custom property.

Contains the collection of Word.CustomProperty objects.

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.

The DocumentCreated object is the top level object created by Application.CreateDocument. A DocumentCreated object is a special Document object.

Represents document properties.

Represents a font.

Represents an inline picture.

Contains a collection of Word.InlinePicture objects.

Contains a collection of Word.Paragraph objects.

Contains a collection of Word.List objects.

Represents the paragraph list item format.

Represents a single paragraph in a selection, range, content control, or document body.

Contains a collection of Word.Paragraph objects.

Represents a contiguous area in a document.

Contains a collection of Word.Range objects.

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.

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.

Represents a section in a Word document.

Contains the collection of the document's Word.Section objects.

Represents a style in a Word document.

Represents a table in a Word document.

Specifies the border style.

Represents a table cell in a Word document.

Contains the collection of the document's TableCell objects.

Contains the collection of the document's Table objects.

Represents a row in a Word document.

Contains the collection of the document's TableRow objects.

An interface describing the data returned by calling annotationCollection.toJSON().

An interface for updating data on the AnnotationCollection object, for use in annotationCollection.set({ ... }).

An interface describing the data returned by calling annotation.toJSON().

An interface describing the data returned by calling body.toJSON().

Represents the body of a document or a section.

An interface for updating data on the Body object, for use in body.set({ ... }).

An interface describing the data returned by calling borderCollection.toJSON().

An interface for updating data on the BorderCollection object, for use in borderCollection.set({ ... }).

An interface describing the data returned by calling border.toJSON().

An interface for updating data on the Border object, for use in border.set({ ... }).

An interface describing the data returned by calling checkboxContentControl.toJSON().

An interface for updating data on the CheckboxContentControl object, for use in checkboxContentControl.set({ ... }).

Provides ways to load properties of only a subset of members of a collection.

An interface describing the data returned by calling comboBoxContentControl.toJSON().

An interface describing the data returned by calling commentCollection.toJSON().

An interface for updating data on the CommentCollection object, for use in commentCollection.set({ ... }).

An interface describing the data returned by calling commentContentRange.toJSON().

An interface for updating data on the CommentContentRange object, for use in commentContentRange.set({ ... }).

An interface describing the data returned by calling comment.toJSON().

An interface describing the data returned by calling commentReplyCollection.toJSON().

An interface for updating data on the CommentReplyCollection object, for use in commentReplyCollection.set({ ... }).

An interface describing the data returned by calling commentReply.toJSON().

An interface for updating data on the CommentReply object, for use in commentReply.set({ ... }).

An interface for updating data on the Comment object, for use in comment.set({ ... }).

An interface describing the data returned by calling contentControlCollection.toJSON().

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 and plain text content controls are supported.

An interface for updating data on the ContentControlCollection object, for use in contentControlCollection.set({ ... }).

An interface describing the data returned by calling contentControl.toJSON().

An interface describing the data returned by calling contentControlListItemCollection.toJSON().

An interface for updating data on the ContentControlListItemCollection object, for use in contentControlListItemCollection.set({ ... }).

An interface describing the data returned by calling contentControlListItem.toJSON().

An interface for updating data on the ContentControlListItem object, for use in contentControlListItem.set({ ... }).

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, and checkbox content controls are supported.

An interface for updating data on the ContentControl object, for use in contentControl.set({ ... }).

An interface describing the data returned by calling critiqueAnnotation.toJSON().

An interface describing the data returned by calling customPropertyCollection.toJSON().

Contains the collection of Word.CustomProperty objects.

An interface for updating data on the CustomPropertyCollection object, for use in customPropertyCollection.set({ ... }).

An interface describing the data returned by calling customProperty.toJSON().

Represents a custom property.

An interface for updating data on the CustomProperty object, for use in customProperty.set({ ... }).

An interface describing the data returned by calling customXmlPartCollection.toJSON().

An interface for updating data on the CustomXmlPartCollection object, for use in customXmlPartCollection.set({ ... }).

An interface describing the data returned by calling customXmlPart.toJSON().

An interface describing the data returned by calling customXmlPartScopedCollection.toJSON().

An interface for updating data on the CustomXmlPartScopedCollection object, for use in customXmlPartScopedCollection.set({ ... }).

An interface describing the data returned by calling documentCreated.toJSON().

The DocumentCreated object is the top level object created by Application.CreateDocument. A DocumentCreated object is a special Document object.

An interface for updating data on the DocumentCreated object, for use in documentCreated.set({ ... }).

An interface describing the data returned by calling document.toJSON().

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.

An interface describing the data returned by calling documentProperties.toJSON().

Represents document properties.

An interface for updating data on the DocumentProperties object, for use in documentProperties.set({ ... }).

An interface for updating data on the Document object, for use in document.set({ ... }).

An interface describing the data returned by calling dropDownListContentControl.toJSON().

An interface describing the data returned by calling fieldCollection.toJSON().

An interface for updating data on the FieldCollection object, for use in fieldCollection.set({ ... }).

An interface describing the data returned by calling field.toJSON().

An interface for updating data on the Field object, for use in field.set({ ... }).

An interface describing the data returned by calling font.toJSON().

Represents a font.

An interface for updating data on the Font object, for use in font.set({ ... }).

An interface describing the data returned by calling inlinePictureCollection.toJSON().

Contains a collection of Word.InlinePicture objects.

An interface for updating data on the InlinePictureCollection object, for use in inlinePictureCollection.set({ ... }).

An interface describing the data returned by calling inlinePicture.toJSON().

Represents an inline picture.

An interface for updating data on the InlinePicture object, for use in inlinePicture.set({ ... }).

An interface describing the data returned by calling listCollection.toJSON().

Contains a collection of Word.List objects.

An interface for updating data on the ListCollection object, for use in listCollection.set({ ... }).

An interface describing the data returned by calling list.toJSON().

An interface describing the data returned by calling listItem.toJSON().

Represents the paragraph list item format.

An interface for updating data on the ListItem object, for use in listItem.set({ ... }).

An interface describing the data returned by calling listLevelCollection.toJSON().

An interface for updating data on the ListLevelCollection object, for use in listLevelCollection.set({ ... }).

An interface describing the data returned by calling listLevel.toJSON().

An interface for updating data on the ListLevel object, for use in listLevel.set({ ... }).

Contains a collection of Word.Paragraph objects.

An interface describing the data returned by calling listTemplate.toJSON().

An interface for updating data on the ListTemplate object, for use in listTemplate.set({ ... }).

An interface describing the data returned by calling noteItemCollection.toJSON().

An interface for updating data on the NoteItemCollection object, for use in noteItemCollection.set({ ... }).

An interface describing the data returned by calling noteItem.toJSON().

An interface for updating data on the NoteItem object, for use in noteItem.set({ ... }).

An interface describing the data returned by calling paragraphCollection.toJSON().

Contains a collection of Word.Paragraph objects.

An interface for updating data on the ParagraphCollection object, for use in paragraphCollection.set({ ... }).

An interface describing the data returned by calling paragraph.toJSON().

An interface describing the data returned by calling paragraphFormat.toJSON().

An interface for updating data on the ParagraphFormat object, for use in paragraphFormat.set({ ... }).

Represents a single paragraph in a selection, range, content control, or document body.

An interface for updating data on the Paragraph object, for use in paragraph.set({ ... }).

An interface describing the data returned by calling rangeCollection.toJSON().

Contains a collection of Word.Range objects.

An interface for updating data on the RangeCollection object, for use in rangeCollection.set({ ... }).

An interface describing the data returned by calling range.toJSON().

Represents a contiguous area in a document.

An interface for updating data on the Range object, for use in range.set({ ... }).

An interface describing the data returned by calling searchOptions.toJSON().

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.

An interface for updating data on the SearchOptions object, for use in searchOptions.set({ ... }).

An interface describing the data returned by calling sectionCollection.toJSON().

Contains the collection of the document's Word.Section objects.

An interface for updating data on the SectionCollection object, for use in sectionCollection.set({ ... }).

An interface describing the data returned by calling section.toJSON().

Represents a section in a Word document.

An interface for updating data on the Section object, for use in section.set({ ... }).

An interface describing the data returned by calling settingCollection.toJSON().

An interface for updating data on the SettingCollection object, for use in settingCollection.set({ ... }).

An interface describing the data returned by calling setting.toJSON().

An interface for updating data on the Setting object, for use in setting.set({ ... }).

An interface describing the data returned by calling shading.toJSON().

An interface for updating data on the Shading object, for use in shading.set({ ... }).

An interface describing the data returned by calling styleCollection.toJSON().

An interface for updating data on the StyleCollection object, for use in styleCollection.set({ ... }).

An interface describing the data returned by calling style.toJSON().

Represents a style in a Word document.

An interface for updating data on the Style object, for use in style.set({ ... }).

An interface describing the data returned by calling tableBorder.toJSON().

Specifies the border style.

An interface for updating data on the TableBorder object, for use in tableBorder.set({ ... }).

An interface describing the data returned by calling tableCellCollection.toJSON().

Contains the collection of the document's TableCell objects.

An interface for updating data on the TableCellCollection object, for use in tableCellCollection.set({ ... }).

An interface describing the data returned by calling tableCell.toJSON().

Represents a table cell in a Word document.

An interface for updating data on the TableCell object, for use in tableCell.set({ ... }).

An interface describing the data returned by calling tableCollection.toJSON().

Contains the collection of the document's Table objects.

An interface for updating data on the TableCollection object, for use in tableCollection.set({ ... }).

An interface describing the data returned by calling table.toJSON().

Represents a table in a Word document.

An interface describing the data returned by calling tableRowCollection.toJSON().

Contains the collection of the document's TableRow objects.

An interface for updating data on the TableRowCollection object, for use in tableRowCollection.set({ ... }).

An interface describing the data returned by calling tableRow.toJSON().

Represents a row in a Word document.

An interface for updating data on the TableRow object, for use in tableRow.set({ ... }).

An interface describing the data returned by calling tableStyle.toJSON().

An interface for updating data on the TableStyle object, for use in tableStyle.set({ ... }).

An interface for updating data on the Table object, for use in table.set({ ... }).

An interface describing the data returned by calling trackedChangeCollection.toJSON().

An interface for updating data on the TrackedChangeCollection object, for use in trackedChangeCollection.set({ ... }).

An interface describing the data returned by calling trackedChange.toJSON().

Specifies the form of a break.

Represents the built-in style in a Word document.

ContentControl appearance.

Specifies supported content control types and subtypes.

The insertion location types.

Specifies the save behavior for Document.save.

This enum sets where the cursor (insertion point) in the document is after a selection.

The supported styles for underline format.

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

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.

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.