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, and checkbox 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 and plain text 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 |
Word.Interfaces.AnnotationCollectionUpdateData |
An interface for updating data on the AnnotationCollection object, for use in |
Word.Interfaces.AnnotationData |
An interface describing the data returned by calling |
Word.Interfaces.BodyData |
An interface describing the data returned by calling |
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 |
Word.Interfaces.CheckboxContentControlData |
An interface describing the data returned by calling |
Word.Interfaces.CheckboxContentControlUpdateData |
An interface for updating data on the CheckboxContentControl object, for use in |
Word.Interfaces.CollectionLoadOptions |
Provides ways to load properties of only a subset of members of a collection. |
Word.Interfaces.CommentCollectionData |
An interface describing the data returned by calling |
Word.Interfaces.CommentCollectionUpdateData |
An interface for updating data on the CommentCollection object, for use in |
Word.Interfaces.CommentContentRangeData |
An interface describing the data returned by calling |
Word.Interfaces.CommentContentRangeUpdateData |
An interface for updating data on the CommentContentRange object, for use in |
Word.Interfaces.CommentData |
An interface describing the data returned by calling |
Word.Interfaces.CommentReplyCollectionData |
An interface describing the data returned by calling |
Word.Interfaces.CommentReplyCollectionUpdateData |
An interface for updating data on the CommentReplyCollection object, for use in |
Word.Interfaces.CommentReplyData |
An interface describing the data returned by calling |
Word.Interfaces.CommentReplyUpdateData |
An interface for updating data on the CommentReply object, for use in |
Word.Interfaces.CommentUpdateData |
An interface for updating data on the Comment object, for use in |
Word.Interfaces.ContentControlCollectionData |
An interface describing the data returned by calling |
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 and plain text content controls are supported. |
Word.Interfaces.ContentControlCollectionUpdateData |
An interface for updating data on the ContentControlCollection object, for use in |
Word.Interfaces.ContentControlData |
An interface describing the data returned by calling |
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, and checkbox content controls are supported. |
Word.Interfaces.ContentControlUpdateData |
An interface for updating data on the ContentControl object, for use in |
Word.Interfaces.CritiqueAnnotationData |
An interface describing the data returned by calling |
Word.Interfaces.CustomPropertyCollectionData |
An interface describing the data returned by calling |
Word.Interfaces.CustomPropertyCollectionUpdateData |
An interface for updating data on the CustomPropertyCollection object, for use in |
Word.Interfaces.CustomPropertyData |
An interface describing the data returned by calling |
Word.Interfaces.CustomPropertyUpdateData |
An interface for updating data on the CustomProperty object, for use in |
Word.Interfaces.CustomXmlPartCollectionData |
An interface describing the data returned by calling |
Word.Interfaces.CustomXmlPartCollectionUpdateData |
An interface for updating data on the CustomXmlPartCollection object, for use in |
Word.Interfaces.CustomXmlPartData |
An interface describing the data returned by calling |
Word.Interfaces.CustomXmlPartScopedCollectionData |
An interface describing the data returned by calling |
Word.Interfaces.CustomXmlPartScopedCollectionUpdateData |
An interface for updating data on the CustomXmlPartScopedCollection object, for use in |
Word.Interfaces.DocumentCreatedData |
An interface describing the data returned by calling |
Word.Interfaces.DocumentCreatedUpdateData |
An interface for updating data on the DocumentCreated object, for use in |
Word.Interfaces.DocumentData |
An interface describing the data returned by calling |
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 |
Word.Interfaces.DocumentPropertiesUpdateData |
An interface for updating data on the DocumentProperties object, for use in |
Word.Interfaces.DocumentUpdateData |
An interface for updating data on the Document object, for use in |
Word.Interfaces.FieldCollectionData |
An interface describing the data returned by calling |
Word.Interfaces.FieldCollectionUpdateData |
An interface for updating data on the FieldCollection object, for use in |
Word.Interfaces.FieldData |
An interface describing the data returned by calling |
Word.Interfaces.FieldUpdateData |
An interface for updating data on the Field object, for use in |
Word.Interfaces.FontData |
An interface describing the data returned by calling |
Word.Interfaces.FontLoadOptions |
Represents a font. |
Word.Interfaces.FontUpdateData |
An interface for updating data on the Font object, for use in |
Word.Interfaces.InlinePictureCollectionData |
An interface describing the data returned by calling |
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 |
Word.Interfaces.InlinePictureData |
An interface describing the data returned by calling |
Word.Interfaces.InlinePictureLoadOptions |
Represents an inline picture. |
Word.Interfaces.InlinePictureUpdateData |
An interface for updating data on the InlinePicture object, for use in |
Word.Interfaces.ListCollectionData |
An interface describing the data returned by calling |
Word.Interfaces.ListCollectionUpdateData |
An interface for updating data on the ListCollection object, for use in |
Word.Interfaces.ListData |
An interface describing the data returned by calling |
Word.Interfaces.ListItemData |
An interface describing the data returned by calling |
Word.Interfaces.ListItemUpdateData |
An interface for updating data on the ListItem object, for use in |
Word.Interfaces.NoteItemCollectionData |
An interface describing the data returned by calling |
Word.Interfaces.NoteItemCollectionUpdateData |
An interface for updating data on the NoteItemCollection object, for use in |
Word.Interfaces.NoteItemData |
An interface describing the data returned by calling |
Word.Interfaces.NoteItemUpdateData |
An interface for updating data on the NoteItem object, for use in |
Word.Interfaces.ParagraphCollectionData |
An interface describing the data returned by calling |
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 |
Word.Interfaces.ParagraphData |
An interface describing the data returned by calling |
Word.Interfaces.ParagraphFormatData |
An interface describing the data returned by calling |
Word.Interfaces.ParagraphFormatUpdateData |
An interface for updating data on the ParagraphFormat object, for use in |
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 |
Word.Interfaces.RangeCollectionData |
An interface describing the data returned by calling |
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 |
Word.Interfaces.RangeData |
An interface describing the data returned by calling |
Word.Interfaces.RangeLoadOptions |
Represents a contiguous area in a document. |
Word.Interfaces.RangeUpdateData |
An interface for updating data on the Range object, for use in |
Word.Interfaces.SearchOptionsData |
An interface describing the data returned by calling |
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 |
Word.Interfaces.SectionCollectionData |
An interface describing the data returned by calling |
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 |
Word.Interfaces.SectionData |
An interface describing the data returned by calling |
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 |
Word.Interfaces.SettingCollectionData |
An interface describing the data returned by calling |
Word.Interfaces.SettingCollectionUpdateData |
An interface for updating data on the SettingCollection object, for use in |
Word.Interfaces.SettingData |
An interface describing the data returned by calling |
Word.Interfaces.SettingUpdateData |
An interface for updating data on the Setting object, for use in |
Word.Interfaces.ShadingData |
An interface describing the data returned by calling |
Word.Interfaces.ShadingUpdateData |
An interface for updating data on the Shading object, for use in |
Word.Interfaces.StyleCollectionData |
An interface describing the data returned by calling |
Word.Interfaces.StyleCollectionUpdateData |
An interface for updating data on the StyleCollection object, for use in |
Word.Interfaces.StyleData |
An interface describing the data returned by calling |
Word.Interfaces.StyleUpdateData |
An interface for updating data on the Style object, for use in |
Word.Interfaces.TableBorderData |
An interface describing the data returned by calling |
Word.Interfaces.TableBorderUpdateData |
An interface for updating data on the TableBorder object, for use in |
Word.Interfaces.TableCellCollectionData |
An interface describing the data returned by calling |
Word.Interfaces.TableCellCollectionUpdateData |
An interface for updating data on the TableCellCollection object, for use in |
Word.Interfaces.TableCellData |
An interface describing the data returned by calling |
Word.Interfaces.TableCellUpdateData |
An interface for updating data on the TableCell object, for use in |
Word.Interfaces.TableCollectionData |
An interface describing the data returned by calling |
Word.Interfaces.TableCollectionUpdateData |
An interface for updating data on the TableCollection object, for use in |
Word.Interfaces.TableData |
An interface describing the data returned by calling |
Word.Interfaces.TableRowCollectionData |
An interface describing the data returned by calling |
Word.Interfaces.TableRowCollectionUpdateData |
An interface for updating data on the TableRowCollection object, for use in |
Word.Interfaces.TableRowData |
An interface describing the data returned by calling |
Word.Interfaces.TableRowUpdateData |
An interface for updating data on the TableRow object, for use in |
Word.Interfaces.TableStyleData |
An interface describing the data returned by calling |
Word.Interfaces.TableStyleUpdateData |
An interface for updating data on the TableStyle object, for use in |
Word.Interfaces.TableUpdateData |
An interface for updating data on the Table object, for use in |
Word.Interfaces.TrackedChangeCollectionData |
An interface describing the data returned by calling |
Word.Interfaces.TrackedChangeCollectionUpdateData |
An interface for updating data on the TrackedChangeCollection object, for use in |
Word.Interfaces.TrackedChangeData |
An interface describing the data returned by calling |
Enums
Word.Alignment | |
Word.BreakType |
Specifies the form of a break. |
Word.ContentControlAppearance |
ContentControl appearance. |
Word.ContentControlType |
Specifies supported content control types and subtypes. |
Word.ErrorCodes | |
Word.HeaderFooterType | |
Word.InsertLocation |
The insertion location types. |
Word.SaveBehavior |
Specifies the save behavior for |
Word.SelectionMode |
This enum sets where the cursor (insertion point) in the document is after a selection. |
Word.UnderlineType |
The supported styles for underline format. |
Functions
Word. |
Executes a batch script that performs actions on the Word object model, using the RequestContext of previously created API objects. |
Word. |
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. |
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
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>
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>
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>
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>
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>
Office Add-ins
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for