word package

Represents an annotation attached to a paragraph.

Contains a collection of Word.Annotation objects.

Represents the application object.

Represents the body of a document or a section.

Represents the Border object for text, a paragraph, or a table.

Represents the collection of border styles.

The data specific to content controls of type CheckBox.

Represents a comment in the document.

Contains a collection of Word.Comment objects.

Represents a comment reply in the document.

Contains a collection of Word.CommentReply objects. Represents all comment replies in one comment thread.

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 an annotation wrapper around critique displayed in the document.

Represents a custom property.

Contains the collection of Word.CustomProperty objects.

Represents a custom XML part.

Contains the collection of Word.CustomXmlPart objects.

Contains the collection of Word.CustomXmlPart objects with a specific namespace.

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

Contains a collection of Word.Field objects.

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

Contains a collection of Word.ListLevel objects.

Represents a ListTemplate.

Represents a footnote or endnote.

Contains a collection of Word.NoteItem objects.

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

Contains a collection of Word.Paragraph objects.

Represents a style of paragraph in a document.

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 setting of the add-in.

Contains the collection of Word.Setting objects.

Represents the shading object.

Represents a style in a Word document.

Contains a collection of Word.Style objects.

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.

Represents the TableStyle object.

Represents a tracked change in a Word document.

Contains a collection of Word.TrackedChange objects.

Holds annotation information that is passed back on annotation inserted event.

Holds annotation information that is passed back on annotation hovered event.

Holds annotation information that is passed back on annotation added event.

Represents action information that's passed back on annotation pop-up action event.

Holds annotation information that is passed back on annotation removed event.

Annotations set produced by the add-in. Currently supporting only critiques.

A structure for the ID and reply IDs of this comment.

Provides information about the comments that raised the comment event.

Provides information about the content control that raised contentControlAdded event.

Provides information about the content control that raised contentControlDataChanged event.

Provides information about the content control that raised contentControlDeleted event.

Provides information about the content control that raised contentControlEntered event.

Provides information about the content control that raised an event.

Provides information about the content control that raised contentControlExited event.

Specifies the options that define which content controls are returned.

Provides information about the content control that raised contentControlSelectionChanged event.

Critique that will be rendered as underline for the specified part of paragraph in the document.

Properties defining the behavior of the pop-up menu for a given critique.

Specifies the options to be included in a compare document operation.

Specifies the options to be included in a getText operation.

Specifies the options to determine what to copy when inserting a file.

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

Contains a collection of Word.Annotation objects.

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

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

Represents an annotation attached to a paragraph.

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

Represents the collection of border styles.

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

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

Represents the Border object for text, a paragraph, or a table.

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

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

The data specific to content controls of type CheckBox.

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 commentCollection.toJSON().

Contains a collection of Word.Comment objects.

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

Represents a comment in the document.

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

Contains a collection of Word.CommentReply objects. Represents all comment replies in one comment thread.

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

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

Represents a comment reply in the document.

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

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

Represents an annotation wrapper around critique displayed in the document.

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

Contains the collection of Word.CustomXmlPart objects.

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

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

Represents a custom XML part.

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

Contains the collection of Word.CustomXmlPart objects with a specific namespace.

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 fieldCollection.toJSON().

Contains a collection of Word.Field objects.

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

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

Represents a field.

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

Contains a collection of Word.ListLevel objects.

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

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

Represents a list level.

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

Represents a ListTemplate.

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

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

Contains a collection of Word.NoteItem objects.

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

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

Represents a footnote or endnote.

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

Represents a style of paragraph in a document.

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

Contains the collection of Word.Setting objects.

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

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

Represents a setting of the add-in.

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

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

Represents the shading object.

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

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

Contains a collection of Word.Style objects.

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

Represents the TableStyle object.

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

Contains a collection of Word.TrackedChange objects.

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

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

Represents a tracked change in a Word document.

Provides information about the paragraphs that raised the paragraphAdded event.

Provides information about the paragraphs that raised the paragraphChanged event.

Provides information about the paragraphs that raised the paragraphDeleted event.

Represents the state of the annotation.

Represents the width of a style's border.

Specifies the form of a break.

Represents the built-in style in a Word document.

ChangeTracking mode.

Specify the track state when ChangeTracking is on.

Specify the current version or the original version of the text.

Specifies the close behavior for Document.close.

Represents how the comments in the event were changed.

Specifies the target document for displaying document comparison differences.

ContentControl appearance.

Represents the state of the content control.

Specifies supported content control types and subtypes.

Represents the color scheme of a critique in the document, affecting underline and highlight.

An enum that specifies an event's source. It can be local or remote (through coauthoring).

Provides information about the type of a raised event.

Represents the kind of field. Indicates how the field works in relation to updating.

Represents the type of Field.

The insertion location types.

Note item type

Represents the outline levels.

Specifies the save behavior for Document.save.

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

Represents the shading texture. To learn more about how to apply backgrounds like textures, see Add, change, or delete the background color in Word.

Represents the type of style.

TrackedChange type.

Represents the character inserted after the list item mark.

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.