word package

Represents an annotation attached to a paragraph.

Contains a collection of Word.Annotation objects.

Represents the application object.

Represents the list of available sources attached to the document (in the current list) or the list of sources available in the application (in the master list).

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.

Represents the BorderUniversal object, which manages borders for a range, paragraph, table, or frame.

Represents the collection of Word.BorderUniversal objects.

Represents a break in a Word document. This could be a page, column, or section break.

Contains a collection of Word.Break objects.

Represents a building block in a template. A building block is pre-built content, similar to autotext, that may contain text, images, and formatting.

Represents a category of building blocks in a Word document.

Represents a collection of Word.BuildingBlockCategory objects in a Word document.

Represents a collection of Word.BuildingBlock objects for a specific building block type and category in a template.

Represents a collection of building block entries in a Word template.

Represents the BuildingBlockGalleryContentControl object.

Represents a type of building block in a Word document.

Represents a collection of building block types in a Word document.

Represents a canvas in the document. To get the corresponding Shape object, use Canvas.shape.

The data specific to content controls of type CheckBox.

Represents the color formatting of a shape or text in Word.

The data specific to content controls of type 'ComboBox'.

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, checkbox, dropdown list, and combo box 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, plain text, checkbox, dropdown list, and combo box content controls are supported.

Represents a list item in a dropdown list or combo box content control.

Contains a collection of Word.ContentControlListItem objects that represent the items in a dropdown list or combo box content control.

Represents an annotation wrapper around critique displayed in the document.

Represents a custom property.

Contains the collection of Word.CustomProperty objects.

Represents an XML node in a tree in the document. The CustomXmlNode object is a member of the Word.CustomXmlNodeCollection object.

Contains a collection of Word.CustomXmlNode objects representing the XML nodes in a document.

Represents a custom XML part.

Contains the collection of Word.CustomXmlPart objects.

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

Represents a CustomXmlPrefixMapping object.

Represents a collection of Word.CustomXmlPrefixMapping objects.

Represents a schema in a Word.CustomXmlSchemaCollection object.

Represents a collection of Word.CustomXmlSchema objects attached to a data stream.

Represents a single validation error in a Word.CustomXmlValidationErrorCollection object.

Represents a collection of Word.CustomXmlValidationError objects.

Represents the DatePickerContentControl object.

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 a document library version.

Represents the collection of Word.DocumentLibraryVersion objects.

Represents document properties.

The data specific to content controls of type DropDownList.

Represents a field.

Contains a collection of Word.Field objects.

Represents the fill formatting for a shape or text.

Represents a font.

Represents a frame. The Frame object is a member of the Word.FrameCollection object.

Represents the collection of Word.Frame objects.

Represents the glow formatting for the font used by the range of text.

Represents the GroupContentControl object.

Represents a hyperlink in a Word document.

Contains a collection of Word.Hyperlink objects.

Represents an inline picture.

Contains a collection of Word.InlinePicture objects.

Represents line and arrowhead formatting. For a line, the LineFormat object contains formatting information for the line itself; for a shape with a border, this object contains formatting information for the shape's border.

Represents line numbers in the left margin or to the left of each newspaper-style column.

Contains a collection of Word.Paragraph objects.

Contains a collection of Word.List objects.

Represents the list formatting characteristics of a range.

Represents the paragraph list item format.

Represents a list level.

Contains a collection of Word.ListLevel objects.

Represents a list template.

Represents a footnote or endnote.

Contains a collection of Word.NoteItem objects.

Represents a page in the document. Page objects manage the page layout and content.

Represents the collection of page.

Represents the page setup settings for a Word document or section.

Represents a window pane. The Pane object is a member of the pane collection. The pane collection includes all the window panes for a single window.

Represents the collection of pane.

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 the PictureContentControl object.

Represents a contiguous area in a document.

Contains a collection of Word.Range objects.

Represents the reflection formatting for a shape in Word.

Represents the RepeatingSectionContentControl object.

Represents a single item in a .

Represents a collection of Word.RepeatingSectionItem objects in a Word document.

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 the ShadingUniversal object, which manages shading for a range, paragraph, frame, or table.

Represents the shadow formatting for a shape or text in Word.

Represents a shape in the header, footer, or document body. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.

Contains a collection of Word.Shape objects. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.

Represents the fill formatting of a shape object.

Represents a shape group in the document. To get the corresponding Shape object, use ShapeGroup.shape.

Represents all the properties for wrapping text around a shape.

Represents an individual source, such as a book, journal article, or interview.

Represents a collection of Word.Source objects.

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 table column in a Word document.

Represents a collection of Word.TableColumn objects in a Word document.

Represents a row in a Word document.

Contains the collection of the document's TableRow objects.

Represents the TableStyle object.

Represents a document template.

Contains a collection of Word.Template objects that represent all the templates that are currently available. This collection includes open templates, templates attached to open documents, and global templates loaded in the Templates and Add-ins dialog box. To learn how to access this dialog in the Word UI, see Load or unload a template or add-in program.

Represents a single text column in a section.

A collection of Word.TextColumn objects that represent all the columns of text in the document or a section of the document.

Represents the text frame of a shape object.

Represents a shape's three-dimensional formatting.

Represents a tracked change in a Word document.

Contains a collection of Word.TrackedChange objects.

Represents the window that displays the document. A window can be split to contain multiple reading panes.

Represents the collection of window objects.

Represents the XML mapping on a Word.ContentControl object between custom XML and that content control. An XML mapping is a link between the text in a content control and an XML element in the custom XML data store for this document.

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

Specifies the options that define which content controls are returned.

The options that define what placeholder to be used in the content control.

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.

The options for adding a node to the XML tree.

Adds one or more schemas to a schema collection that can then be added to a stream in the data store and to the schema library.

The options that define the descriptive error text and the state of clearedOnUpdate.

The options that define the prefix mapping and the source of the custom XML data.

Inserts a new node just before the context node in the tree.

Inserts a new node just before the context node in the tree.

Removes the specified child node and replaces it with a different node in the same location.

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

Specifies the options to be included in a getText operation.

Specifies the options for adding to a Word.HyperlinkCollection object.

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

Specifies the options to determine location and size when inserting a shape.

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

Represents the application object.

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

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

Represents the list of available sources attached to the document (in the current list) or the list of sources available in the application (in the master list).

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

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 describing the data returned by calling borderUniversalCollection.toJSON().

Represents the collection of Word.BorderUniversal objects.

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

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

Represents the BorderUniversal object, which manages borders for a range, paragraph, table, or frame.

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

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

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

Contains a collection of Word.Break objects.

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

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

Represents a break in a Word document.

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

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

Represents a category of building blocks in a Word document.

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

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

Represents the BuildingBlockGalleryContentControl object.

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

Represents a building block in a template. A building block is pre-built content, similar to autotext, that may contain text, images, and formatting.

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

Represents a type of building block in a Word document.

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

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

Represents a canvas in the document. To get the corresponding Shape object, use Canvas.shape.

An interface for updating data on the Canvas object, for use in canvas.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 colorFormat.toJSON().

Represents the color formatting of a shape or text in Word.

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

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

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, plain text, checkbox, dropdown list, and combo box 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().

Contains a collection of Word.ContentControlListItem objects that represent the items in a dropdown list or combo box content control.

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

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

Represents a list item in a dropdown list or combo box content control.

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, checkbox, dropdown list, and combo box 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 customXmlNodeCollection.toJSON().

Contains a collection of Word.CustomXmlNode objects representing the XML nodes in a document.

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

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

Represents an XML node in a tree in the document. The CustomXmlNode object is a member of the Word.CustomXmlNodeCollection object.

An interface for updating data on the CustomXmlNode object, for use in customXmlNode.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 for updating data on the CustomXmlPart object, for use in customXmlPart.set({ ... }).

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

Represents a collection of Word.CustomXmlPrefixMapping objects.

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

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

Represents a CustomXmlPrefixMapping object.

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

Represents a collection of Word.CustomXmlSchema objects attached to a data stream.

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

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

Represents a schema in a Word.CustomXmlSchemaCollection object.

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

Represents a collection of Word.CustomXmlValidationError objects.

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

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

Represents a single validation error in a Word.CustomXmlValidationErrorCollection object.

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

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

Represents the DatePickerContentControl object.

An interface for updating data on the DatePickerContentControl object, for use in datePickerContentControl.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().

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

Represents the collection of Word.DocumentLibraryVersion objects.

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

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

Represents a document library version.

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

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

Represents the fill formatting for a shape or text.

An interface for updating data on the FillFormat object, for use in fillFormat.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 frameCollection.toJSON().

Represents the collection of Word.Frame objects.

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

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

Represents a frame. The Frame object is a member of the Word.FrameCollection object.

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

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

Represents the glow formatting for the font used by the range of text.

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

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

Represents the GroupContentControl object.

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

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

Contains a collection of Word.Hyperlink objects.

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

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

Represents a hyperlink in a Word document.

An interface for updating data on the Hyperlink object, for use in hyperlink.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 lineFormat.toJSON().

Represents line and arrowhead formatting. For a line, the LineFormat object contains formatting information for the line itself; for a shape with a border, this object contains formatting information for the shape's border.

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

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

Represents line numbers in the left margin or to the left of each newspaper-style column.

An interface for updating data on the LineNumbering object, for use in lineNumbering.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 listFormat.toJSON().

Represents the list formatting characteristics of a range.

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

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

Represents the collection of page.

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

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

Represents a page in the document. Page objects manage the page layout and content.

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

Represents the page setup settings for a Word document or section.

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

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

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

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

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

Represents the PictureContentControl object.

An interface for updating data on the PictureContentControl object, for use in pictureContentControl.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 reflectionFormat.toJSON().

Represents the reflection formatting for a shape in Word.

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

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

Represents the RepeatingSectionContentControl object.

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

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

Represents a single item in a .

An interface for updating data on the RepeatingSectionItem object, for use in repeatingSectionItem.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 describing the data returned by calling shadingUniversal.toJSON().

Represents the ShadingUniversal object, which manages shading for a range, paragraph, frame, or table.

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

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

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

Represents the shadow formatting for a shape or text in Word.

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

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

Contains a collection of Word.Shape objects. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.

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

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

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

Represents the fill formatting of a shape object.

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

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

Represents a shape group in the document. To get the corresponding Shape object, use ShapeGroup.shape.

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

Represents a shape in the header, footer, or document body. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.

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

Represents all the properties for wrapping text around a shape.

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

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

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

Represents a collection of Word.Source objects.

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

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

Represents an individual source, such as a book, journal article, or interview.

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

Represents a collection of Word.TableColumn objects in a Word document.

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

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

Represents a table column in a Word document.

An interface for updating data on the TableColumn object, for use in tableColumn.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 templateCollection.toJSON().

Contains a collection of Word.Template objects that represent all the templates that are currently available. This collection includes open templates, templates attached to open documents, and global templates loaded in the Templates and Add-ins dialog box. To learn how to access this dialog in the Word UI, see Load or unload a template or add-in program.

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

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

Represents a document template.

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

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

A collection of Word.TextColumn objects that represent all the columns of text in the document or a section of the document.

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

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

Represents a single text column in a section.

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

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

Represents the text frame of a shape object.

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

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

Represents a shape's three-dimensional formatting.

An interface for updating data on the ThreeDimensionalFormat object, for use in threeDimensionalFormat.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.

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

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

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

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

Represents the XML mapping on a Word.ContentControl object between custom XML and that content control. An XML mapping is a link between the text in a content control and an XML element in the custom XML data store for this document.

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

Represents options for counting numbered items in a range.

Represents options for applying a list template to a range.

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 options for a new text column in a document or section of a document.

The options that define the prefix mapping and the source of the custom XML data.

Represents the state of the annotation.

Specifies the length of the arrowhead at the end of a line.

Specifies the style of the arrowhead at the end of a line.

Specifies the width of the arrowhead at the end of a line.

Indicates the bevel type of a Word.ThreeDimensionalFormat object.

Represents the types of body objects.

Specifies the border style for an object.

Represents the width of a style's border.

Specifies the form of a break.

Specifies the type of building block.

Represents the built-in style in a Word document.

Calendar types.

Represents the possible change tracking modes.

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 color index values in a Word document.

Specifies the color type.

Represents how the comments in the event were changed.

Specifies the target document for displaying document comparison differences.

ContentControl appearance.

Date storage formats for Word.DatePickerContentControl.

Content control level types.

Represents the state of the content control.

Specifies supported content control types and subtypes.

Specifies whether the formatting from the previous list can be continued.

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

Represents the type of a Word.CustomXmlNode.

Represents the type of a Word.CustomXmlValidationError.

Specifies the default list behavior for a list.

Specifies how a building block is inserted into a document.

Specifies the type of emphasis mark to use for a character or designated character string.

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.

Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill.

Represents the East Asian language to use when breaking lines of text in the specified document or template.

Represents the level of line breaking to use for East Asian languages in the specified document or template.

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

Represents the type of Field.

Specifies a shape's fill type.

Specifies the direction in which text flows from one text column to the next.

Represents how Word interprets the rule used to determine the height or width of a Word.Frame.

Specifies the shape type for a GeometricShape object.

Specifies the type of gradient used in a shape's fill.

Specifies the style for a gradient fill.

Specifies where the gutter appears in the document.

Specifies whether the gutter style should conform to left-to-right text flow or right-to-left text flow.

Specifies the hyperlink type.

Specifies how to handle any conflicts, that is, when imported styles have the same name as existing styles in the current document.

The insertion location types.

Specifies the character spacing adjustment for a document.

Represents the language ID of a Word document.

Specifies how text is laid out in the layout mode for the current document.

Specifies the type of ligature applied to a font.

Indicates the effects lighting for an object.

Specifies the dash style for a line.

Specifies the style for a line.

Specifies the width of an object's border.

Specifies the portion of a list to which to apply a list template.

Represents the list type.

Note item type

Specifies the number form setting for an OpenType font.

Specifies the numbering rule to apply.

Specifies the number spacing setting for an OpenType font.

Specifies the type of numbers in a list.

Represents the outline levels.

Specifies the graphical page border setting of a page.

Specifies a page layout orientation.

Specifies the type of vertical alignment to apply.

Specifies a paper size.

Specifies the fill pattern used in a shape.

Specifies the preferred unit of measure to use when measuring the width of an item.

Indicates the effects camera type used by the specified object.

Specifies the direction that the extrusion's sweep path takes away from the extruded shape (the front face of the extrusion).

Specifies which predefined gradient to use to fill a shape.

Specifies the location of lighting on an extruded (three-dimensional) shape relative to the shape.

Specifies the intensity of light used on a shape.

Specifies the extrusion surface material.

Specifies texture to be used to fill a shape.

Specifies an extrusion (three-dimensional) format.

Represents the location of a range. You can get range by calling getRange on different objects such as Word.Paragraph and Word.ContentControl.

Specifies the type of the Word.ReflectionFormat object.

Represents what the horizontal position of a shape is relative to. For more information about margins, see Change the margins in your Word document.

Represents what the horizontal or vertical size of a shape is relative to. For more information about margins, see Change the margins in your Word document.

Represents what the vertical position of a shape is relative to. For more information about margins, see Change the margins in your Word document.

Specifies the way Word adjusts the table when the left indent is changed.

Specifies the save behavior for Document.save.

Specifies how Word displays the reading order and alignment for the specified sections.

Specifies the type of section break for the specified item.

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.

Specifies the type of shadowing effect.

Specifies the type of shadow displayed with a shape.

Determines the type of automatic sizing allowed.

Specifies a shape's fill type.

Specifies which part of the shape retains its position when the shape is scaled.

Specifies the scale size type of a shape.

Specifies the orientation for the text frame in a shape.

Specifies the vertical alignment for the text frame in a shape.

Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farther from the respective page margin.

Specifies how to wrap document text around a shape. For more details, see the "Text Wrapping" tab of Layout options.

Represents the shape type.

Represents the type of style.

Specifies the stylistic set to apply to the font.

Specifies the type of template.

Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill.

Specifies the texture type for the selected fill.

Specifies the theme colors for document themes.

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.