Word JavaScript API

https://learn.microsoft.com/en-us/javascript/api/word
Admin
Word JavaScript API is a comprehensive library that enables developers to programmatically create,...
Tokens:188,834
Snippets:772
Trust Score:10
Update:6 months ago
Show doc for...
Tokens:
Raw
### Page Setup Interfaces

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=excel-js-1.15

Interfaces for configuring page setup options, including data retrieval, load options, and update data.

```APIDOC
## Word.Interfaces.PageSetupData

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

### Method
N/A (Interface definition)

### Endpoint
N/A

## Word.Interfaces.PageSetupLoadOptions

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

### Method
N/A (Interface definition)

### Endpoint
N/A

## Word.Interfaces.PageSetupUpdateData

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

### Method
N/A (Interface definition)

### Endpoint
N/A
```

--------------------------------

### Page Setup Interfaces

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=excel-js-1.7

Interfaces for managing page setup settings, including data, load options, and update data.

```APIDOC
## Word.Interfaces.PageSetupData

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

### Method
N/A (Interface definition)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## Word.Interfaces.PageSetupLoadOptions

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

### Method
N/A (Interface definition)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## Word.Interfaces.PageSetupUpdateData

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

### Method
N/A (Interface definition)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### Execute a batch script in Word

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=excel-js-1.15

Use the *.run methods to automatically create a RequestContext for interacting with the Office file. This example shows the basic structure for interacting with the Word document.

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

```

--------------------------------

### Page Interfaces

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=excel-js-1.4

Interfaces for managing pages and page setup within a Word document.

```APIDOC
## Word.Interfaces.PageCollectionData

### Description
An interface describing the data returned by calling `pageCollection.toJSON()`.

### Method
N/A (Interface definition)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## Word.Interfaces.PageCollectionLoadOptions

### Description
Represents the collection of Word.Page objects.

### Method
N/A (Interface definition)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## Word.Interfaces.PageCollectionUpdateData

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

### Method
N/A (Interface definition)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## Word.Interfaces.PageData

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

### Method
N/A (Interface definition)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## Word.Interfaces.PageLoadOptions

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

### Method
N/A (Interface definition)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## Word.Interfaces.PageSetupData

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

### Method
N/A (Interface definition)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## Word.Interfaces.PageSetupLoadOptions

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

### Method
N/A (Interface definition)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## Word.Interfaces.PageSetupUpdateData

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

### Method
N/A (Interface definition)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## Word.Interfaces.PaneCollectionData

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

### Method
N/A (Interface definition)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## Word.Interfaces.PaneCollectionLoadOptions

### Description
Represents the collection of Word.Pane objects.

### Method
N/A (Interface definition)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### Go To Options

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=excel-js-1.15

Represents the options for the Selection.goTo and Document.goTo methods.

```APIDOC
## Word.GoToOptions

### Description
Represents the options for the `Selection.goTo` and `Document.goTo` methods.

### Method
Not applicable (this is an options object).

### Endpoint
Not applicable (this is an options object).

### Parameters
This object is used to configure options for `goTo` operations on selections or documents. Specific fields are not detailed in the provided text.
```

--------------------------------

### Get Text Options

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=excel-js-1.15

Specifies the options to be included in a Paragraph.getText operation.

```APIDOC
## Word.GetTextOptions

### Description
Specifies the options to be included in a `Paragraph.getText` operation.

### Method
Not applicable (this is an options object).

### Endpoint
Not applicable (this is an options object).

### Parameters
This object is used to configure options for the `getText` operation on a paragraph. Specific fields are not detailed in the provided text.
```

--------------------------------

### Word.Interfaces.ApplicationLoadOptions

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=outlook-js-1.12

Represents the `Application` object.

```APIDOC
## Word.Interfaces.ApplicationLoadOptions

### Description
Represents the `Application` object.

### Method
Not applicable (this is an options object).

### Endpoint
Not applicable (this is an options object).

### Parameters
This object does not have direct parameters. Its fields are used to specify which properties of the application to load.

### Request Example
```json
{
  "$select": ["name", "version"]
}
```

### Response
This object is used for configuration and does not have a direct response. The response would be from the method used to load application information.
```

--------------------------------

### Get Template Type

Source: https://learn.microsoft.com/en-us/javascript/api/word/word.interfaces.templateloadoptions

Use `type` to retrieve the type of the document template.

```typescript
type?: boolean;
```

--------------------------------

### Word.GoToOptions

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=outlook-js-1.12

Represents the options for the Selection.goTo and Document.goTo methods.

```APIDOC
## Word.GoToOptions

### Description
Represents the options for the `Selection.goTo` and `Document.goTo` methods.

### Method
Not applicable (this is an options object).

### Endpoint
Not applicable (this is an options object).

### Parameters
This object does not have direct parameters. Its fields are used to configure the `goTo` methods.

### Request Example
```json
{
  "destination": "Page 5",
  "select": true
}
```

### Response
This object is used for configuration and does not have a direct response. The response would be from the `goTo` methods themselves.
```

--------------------------------

### Get Template Path

Source: https://learn.microsoft.com/en-us/javascript/api/word/word.interfaces.templateloadoptions

Use `path` to retrieve the file path to the document template.

```typescript
path?: boolean;
```

--------------------------------

### ApplicationLoadOptions Interface

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=excel-js-1.15

Represents the `Application` object.

```APIDOC
## Word.Interfaces.ApplicationLoadOptions

### Description
Represents the `Application` object.

### Method
Not applicable (this is an options interface).

### Endpoint
Not applicable (this is an options interface).

### Parameters
This interface is used for loading options related to the `Application` object. Specific fields are not detailed in the provided text.
```

--------------------------------

### Get Template Name Only

Source: https://learn.microsoft.com/en-us/javascript/api/word/word.interfaces.templateloadoptions

Use `name` to retrieve only the name of the document template, excluding any path information.

```typescript
name?: boolean;
```

--------------------------------

### Get Full Template Name

Source: https://learn.microsoft.com/en-us/javascript/api/word/word.interfaces.templateloadoptions

Use `fullName` to retrieve the complete name of the template, including its path.

```typescript
fullName?: boolean;
```

--------------------------------

### Setting Interfaces

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=outlook-js-1.14

Interfaces for managing Setting data, load options, and update data.

```APIDOC
## Setting

### Description
Interface describing the data returned by calling `setting.toJSON()`.

### Method
N/A (Interface definition)

### Endpoint
N/A (Interface definition)

### Parameters
N/A (Interface definition)

### Request Example
```json
{
  "example": "{\"someProperty\": \"someValue\"}"
}
```

### Response
#### Success Response (200)
N/A (Interface definition)

#### Response Example
```json
{
  "example": "{\"someProperty\": \"someValue\"}"
}
```
```

```APIDOC
## SettingCollection

### Description
Interface describing the data returned by calling `settingCollection.toJSON()`.

### Method
N/A (Interface definition)

### Endpoint
N/A (Interface definition)

### Parameters
N/A (Interface definition)

### Request Example
```json
{
  "example": "{\"someProperty\": \"someValue\"}"
}
```

### Response
#### Success Response (200)
N/A (Interface definition)

#### Response Example
```json
{
  "example": "{\"someProperty\": \"someValue\"}"
}
```
```

```APIDOC
## SettingCollectionLoadOptions

### Description
Contains the collection of the document's Word.Setting objects.

### Method
N/A (Interface definition)

### Endpoint
N/A (Interface definition)

### Parameters
N/A (Interface definition)

### Request Example
```json
{
  "example": "{\"someProperty\": \"someValue\"}"
}
```

### Response
#### Success Response (200)
N/A (Interface definition)

#### Response Example
```json
{
  "example": "{\"someProperty\": \"someValue\"}"
}
```
```

```APIDOC
## SettingCollectionUpdateData

### Description
Interface for updating data on the `SettingCollection` object, for use in `settingCollection.set({ ... })`.

### Method
N/A (Interface definition)

### Endpoint
N/A (Interface definition)

### Parameters
N/A (Interface definition)

### Request Example
```json
{
  "example": "{\"someProperty\": \"someValue\"}"
}
```

### Response
#### Success Response (200)
N/A (Interface definition)

#### Response Example
```json
{
  "example": "{\"someProperty\": \"someValue\"}"
}
```
```

```APIDOC
## SettingLoadOptions

### Description
Represents a setting of the add-in.

### Method
N/A (Interface definition)

### Endpoint
N/A (Interface definition)

### Parameters
N/A (Interface definition)

### Request Example
```json
{
  "example": "{\"someProperty\": \"someValue\"}"
}
```

### Response
#### Success Response (200)
N/A (Interface definition)

#### Response Example
```json
{
  "example": "{\"someProperty\": \"someValue\"}"
}
```
```

```APIDOC
## SettingUpdateData

### Description
Interface for updating data on the `Setting` object, for use in `setting.set({ ... })`.

### Method
N/A (Interface definition)

### Endpoint
N/A (Interface definition)

### Parameters
N/A (Interface definition)

### Request Example
```json
{
  "example": "{\"someProperty\": \"someValue\"}"
}
```

### Response
#### Success Response (200)
N/A (Interface definition)

#### Response Example
```json
{
  "example": "{\"someProperty\": \"someValue\"}"
}
```
```

--------------------------------

### Word Utility and Configuration Objects

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=powerpoint-js-preview

Objects for managing document settings, search, and application context.

```APIDOC
## Word.LinkFormat

### Description
Represents the linking characteristics for an OLE object or picture.

## Word.PageSetup

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

## Word.ReadabilityStatistic

### Description
Represents one of the readability statistics for the document or range.

## Word.RevisionsFilter

### Description
Represents the current settings related to the display of reviewers' comments and revision marks in the document.

## Word.SearchOptions

### Description
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.RequestContext

### Description
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.
```

--------------------------------

### Page Interfaces

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=excel-js-1.14

Interfaces for managing page collections and individual pages, including data, load options, and setup.

```APIDOC
## Word.Interfaces.PageCollectionData

### Description
An interface describing the data returned by calling `pageCollection.toJSON()`.

### Method
N/A (Interface definition)

### Endpoint
N/A

## Word.Interfaces.PageCollectionLoadOptions

### Description
Represents the collection of Word.Page objects.

### Method
N/A (Interface definition)

### Endpoint
N/A

## Word.Interfaces.PageCollectionUpdateData

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

### Method
N/A (Interface definition)

### Endpoint
N/A

## Word.Interfaces.PageData

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

### Method
N/A (Interface definition)

### Endpoint
N/A

## Word.Interfaces.PageLoadOptions

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

### Method
N/A (Interface definition)

### Endpoint
N/A

## Word.Interfaces.PageSetupData

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

### Method
N/A (Interface definition)

### Endpoint
N/A

## Word.Interfaces.PageSetupLoadOptions

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

### Method
N/A (Interface definition)

### Endpoint
N/A

## Word.Interfaces.PageSetupUpdateData

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

### Method
N/A (Interface definition)

### Endpoint
N/A
```

--------------------------------

### Page Interfaces

Source: https://learn.microsoft.com/en-us/javascript/api/word

Interfaces for managing page collections, individual pages, page setup, and panes within a Word document.

```APIDOC
## Word.Interfaces.PageCollectionData

### Description
An interface describing the data returned by calling `pageCollection.toJSON()`.

### Method
N/A (Interface definition)

### Endpoint
N/A

## Word.Interfaces.PageCollectionLoadOptions

### Description
Represents the collection of Word.Page objects.

### Method
N/A (Interface definition)

### Endpoint
N/A

## Word.Interfaces.PageCollectionUpdateData

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

### Method
N/A (Interface definition)

### Endpoint
N/A

## Word.Interfaces.PageData

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

### Method
N/A (Interface definition)

### Endpoint
N/A

## Word.Interfaces.PageLoadOptions

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

### Method
N/A (Interface definition)

### Endpoint
N/A

## Word.Interfaces.PageSetupData

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

### Method
N/A (Interface definition)

### Endpoint
N/A

## Word.Interfaces.PageSetupLoadOptions

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

### Method
N/A (Interface definition)

### Endpoint
N/A

## Word.Interfaces.PageSetupUpdateData

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

### Method
N/A (Interface definition)

### Endpoint
N/A

## Word.Interfaces.PaneCollectionData

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

### Method
N/A (Interface definition)

### Endpoint
N/A

## Word.Interfaces.PaneCollectionLoadOptions

### Description
Represents the collection of Word.Pane objects.

### Method
N/A (Interface definition)

### Endpoint
N/A
```

--------------------------------

### Collection and General Interfaces

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=outlook-js-1.14

General interfaces for collections and loading options.

```APIDOC
## Word.Interfaces.CollectionLoadOptions

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

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

--------------------------------

### WebSettings Interfaces

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=excel-js-1.20

Interfaces for describing data, load options, and update data for the WebSettings object.

```APIDOC
## Word.Interfaces.WebSettingsData

### Description
An interface describing the data returned by calling `webSettings.toJSON()`.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **webSettingsData** (object) - The data of the web settings.

#### Response Example
N/A
```

```APIDOC
## Word.Interfaces.WebSettingsLoadOptions

### Description
Represents the settings for saving a Word document as a webpage.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **webSettingsLoadOptions** (object) - The load options for web settings.

#### Response Example
N/A
```

```APIDOC
## Word.Interfaces.WebSettingsUpdateData

### Description
An interface for updating data on the `WebSettings` object, for use in `webSettings.set({ ... })`.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **webSettingsUpdateData** (object) - The data to update the web settings with.

#### Response Example
N/A
```

--------------------------------

### Execute a batch script with Word.run

Source: https://learn.microsoft.com/en-us/javascript/api/word

Use this pattern to interact with the Word document. The run method automatically creates a RequestContext.

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

--------------------------------

### POST /run

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=outlook-js-1.5

Executes a batch script that performs actions on the Word object model. This function can be used with previously created API objects or with a new RequestContext.

```APIDOC
## POST /run

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

### Method
POST

### Endpoint
/run

### Parameters
#### Query Parameters
None

#### Request Body
This endpoint does not explicitly define a request body in the provided documentation. The `run` function itself takes parameters that are passed to the script execution.

### Request Example
```typescript
// Example using Word.run with previously created API objects
Word.run(existingObjects, async (context) => {
    // Your code here
    await context.sync();
});

// Example using Word.run with a new RequestContext
Word.run(async (context) => {
    // Your code here
    await context.sync();
});
```

### Response
#### Success Response (200)
- **T** (Promise) - A promise that resolves with the result of the batch script execution.

#### Response Example
```json
{
  "example": "// The resolved value of the promise returned by the batch function."
}
```

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

##### Parameters 
- **objects** (OfficeExtension.ClientObject[]) - Required - 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>) - Required - 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>** - A promise that resolves with the result of the batch script execution.
```

--------------------------------

### Setting Interfaces

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=excel-js-1.19

Interfaces for managing add-in settings within a Word document.

```APIDOC
## Word.Interfaces.SettingCollectionData

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

### Method
Not applicable (Interface definition)

### Endpoint
Not applicable (Interface definition)
```

```APIDOC
## Word.Interfaces.SettingCollectionLoadOptions

### Description
Contains the collection of Word.Setting objects.

### Method
Not applicable (Interface definition)

### Endpoint
Not applicable (Interface definition)
```

```APIDOC
## Word.Interfaces.SettingCollectionUpdateData

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

### Method
Not applicable (Interface definition)

### Endpoint
Not applicable (Interface definition)
```

```APIDOC
## Word.Interfaces.SettingData

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

### Method
Not applicable (Interface definition)

### Endpoint
Not applicable (Interface definition)
```

```APIDOC
## Word.Interfaces.SettingLoadOptions

### Description
Represents a setting of the add-in.

### Method
Not applicable (Interface definition)

### Endpoint
Not applicable (Interface definition)
```

```APIDOC
## Word.Interfaces.SettingUpdateData

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

### Method
Not applicable (Interface definition)

### Endpoint
Not applicable (Interface definition)
```

--------------------------------

### POST Word.run

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=outlook-js-1.9

Executes a batch script that performs actions on the Word object model.

```APIDOC
## POST Word.run

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

### Method
POST

### Endpoint
/Word/run

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None (The function signature implies parameters are passed directly, not in a request body for this documentation format).

### Request Example
```typescript
// Example for Word.run(objects, batch)
Word.run(existingObjects, async function (context) {
    // Your code here
    await context.sync();
});

// Example for Word.run(batch)
Word.run(async function (context) {
    // Your code here
    await context.sync();
});
```

### Response
#### Success Response (200)
- **T** (any) - The result of the batch function.

#### Response Example
```json
{
  "result": "Your returned value from the batch function"
}
```

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

**Parameters**

- **objects** (OfficeExtension.ClientObject[]) - Required - 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>) - Required - 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>** - A promise that resolves with the result of the batch function.

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

**Parameters**

- **batch** ((context: Word.RequestContext) => Promise<T>) - Required - 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>** - A promise that resolves with the result of the batch function.
```

--------------------------------

### Word API Interfaces: View, WebSettings, Window, XmlMapping

Source: https://learn.microsoft.com/en-us/javascript/api/word

Interfaces for managing View, WebSettings, Window, and XmlMapping objects, including data, load options, and update data.

```APIDOC
## Word API Interfaces

### View Interfaces

- **Word.Interfaces.ViewData**
  - Description: An interface describing the data returned by calling `view.toJSON()`.

- **Word.Interfaces.ViewLoadOptions**
  - Description: Contains the view attributes (such as show all, field shading, and table gridlines) for a window or pane.

- **Word.Interfaces.ViewUpdateData**
  - Description: An interface for updating data on the `View` object, for use in `view.set({ ... })`.

### WebSettings Interfaces

- **Word.Interfaces.WebSettingsData**
  - Description: An interface describing the data returned by calling `webSettings.toJSON()`.

- **Word.Interfaces.WebSettingsLoadOptions**
  - Description: Represents the settings for saving a Word document as a webpage.

- **Word.Interfaces.WebSettingsUpdateData**
  - Description: An interface for updating data on the `WebSettings` object, for use in `webSettings.set({ ... })`.

### Window Interfaces

- **Word.Interfaces.WindowCollectionData**
  - Description: An interface describing the data returned by calling `windowCollection.toJSON()`.

- **Word.Interfaces.WindowCollectionLoadOptions**
  - Description: Represents the collection of Word.Window objects.

- **Word.Interfaces.WindowCollectionUpdateData**
  - Description: An interface for updating data on the `WindowCollection` object, for use in `windowCollection.set({ ... })`.

- **Word.Interfaces.WindowData**
  - Description: An interface describing the data returned by calling `window.toJSON()`.

- **Word.Interfaces.WindowLoadOptions**
  - Description: Represents the window that displays the document. A window can be split to contain multiple reading panes.

- **Word.Interfaces.WindowUpdateData**
  - Description: An interface for updating data on the `Window` object, for use in `window.set({ ... })`.

### XmlMapping Interfaces

- **Word.Interfaces.XmlMappingData**
  - Description: An interface describing the data returned by calling `xmlMapping.toJSON()`.

- **Word.Interfaces.XmlMappingLoadOptions**
  - Description: 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.

- **Word.Interfaces.XmlMappingUpdateData**
  - Description: An interface for updating data on the `XmlMapping` object, for use in `xmlMapping.set({ ... })`.

### XmlNode Interfaces

- **Word.Interfaces.XmlNodeCollectionData**
  - Description: An interface describing the data returned by calling `xmlNodeCollection.toJSON()`.

- **Word.Interfaces.XmlNodeCollectionLoadOptions**
  - Description: Represents the collection of Word.XmlNode objects.

- **Word.Interfaces.XmlNodeCollectionUpdateData**
  - Description: An interface for updating data on the `XmlNodeCollection` object, for use in `xmlNodeCollection.set({ ... })`.

- **Word.Interfaces.XmlNodeData**
  - Description: An interface describing the data returned by calling `xmlNode.toJSON()`.

- **Word.Interfaces.XmlNodeLoadOptions**
  - Description: Represents a single XML node applied to the document.

- **Word.Interfaces.XmlNodeUpdateData**
  - Description: An interface for updating data on the `XmlNode` object, for use in `xmlNode.set({ ... })`.
```

--------------------------------

### Word.run(object, batch)

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=outlook-js-1.1

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.

```APIDOC
## Word.run(object, batch)

### Description
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.

### Method
`Word.run`

### Parameters
#### 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>
```

--------------------------------

### WebSettings Interfaces

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=outlook-js-1.1

Interfaces for managing web settings, including data, load options, and update data.

```APIDOC
## Word.Interfaces.WebSettingsData

### Description
An interface describing the data returned by calling `webSettings.toJSON()`.

### Method
N/A

### Endpoint
N/A

## Word.Interfaces.WebSettingsLoadOptions

### Description
Represents the settings for saving a Word document as a webpage.

### Method
N/A

### Endpoint
N/A

## Word.Interfaces.WebSettingsUpdateData

### Description
An interface for updating data on the `WebSettings` object, for use in `webSettings.set({ ... })`.

### Method
N/A

### Endpoint
N/A
```

--------------------------------

### Context, Review, and Search Objects

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=outlook-js-1.1

Objects for managing context, review features, and search operations.

```APIDOC
## Word.RequestContext

### Description
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.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## Word.Reviewer

### Description
Represents a single reviewer of a document in which changes have been tracked. The `Reviewer` object is a member of the Word.ReviewerCollection object.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## Word.ReviewerCollection

### Description
A collection of Word.Reviewer objects that represents the reviewers of one or more documents. The `ReviewerCollection` object contains the names of all reviewers who have reviewed documents opened or edited on a computer.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## Word.Revision

### Description
Represents a single tracked change in a document.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## Word.RevisionCollection

### Description
A collection of Word.Revision objects that represent the changes marked with revision marks in a range or document.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## Word.RevisionsFilter

### Description
Represents the current settings related to the display of reviewers' comments and revision marks in the document.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## Word.SearchOptions

### Description
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.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## Word.Setting

### Description
Represents a setting of the add-in.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### Word.run(batch)

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=outlook-js-1.1

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.

```APIDOC
## Word.run(batch)

### Description
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.

### Method
`Word.run`

### Parameters
#### 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>
```

--------------------------------

### Window Interfaces

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=outlook-js-1.1

Interfaces for the Window object, including data, load options, and update data.

```APIDOC
## Word.Interfaces.WindowData

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

### Method
N/A

### Endpoint
N/A

## Word.Interfaces.WindowLoadOptions

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

### Method
N/A

### Endpoint
N/A

## Word.Interfaces.WindowUpdateData

### Description
An interface for updating data on the `Window` object, for use in `window.set({ ... })`.

### Method
N/A

### Endpoint
N/A
```

--------------------------------

### Word.Interfaces.BorderLoadOptions

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=outlook-js-1.12

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

```APIDOC
## Word.Interfaces.BorderLoadOptions

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

### Method
Not applicable (this is an options object).

### Endpoint
Not applicable (this is an options object).

### Parameters
This object does not have direct parameters. Its fields are used to specify which properties of the border to load.

### Request Example
```json
{
  "$select": ["type", "color", "width"]
}
```

### Response
This object is used for configuration and does not have a direct response. The response would be from the method used to load border information.
```

--------------------------------

### OLE and Link Objects

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=excel-js-1.15

Objects for handling OLE objects and linking.

```APIDOC
## Word.LinkFormat

### Description
Represents the linking characteristics for an OLE object or picture.

## Word.OleFormat

### Description
Represents the OLE characteristics (other than linking) for an OLE object, ActiveX control, or field.
```

--------------------------------

### Word Configuration Options

Source: https://learn.microsoft.com/en-us/javascript/api/word

Overview of various configuration option classes used for document operations such as sending faxes, reviewing documents, and inserting content.

```APIDOC
## Word Configuration Options

### Description
These classes provide configuration options for specific methods within the Word JavaScript API, such as document manipulation and content insertion.

### Available Options
- **Word.DocumentSendFaxOverInternetOptions**: Configuration for Document.sendFaxOverInternet.
- **Word.DocumentSendForReviewOptions**: Configuration for Document.sendForReview.
- **Word.GetTextOptions**: Options for Paragraph.getText.
- **Word.GoToOptions**: Options for Selection.goTo and Document.goTo.
- **Word.HyperlinkAddOptions**: Options for adding to Word.HyperlinkCollection.
- **Word.IndexAddOptions**: Options for creating an index.
- **Word.IndexMarkAllEntriesOptions**: Options for marking all index entries.
- **Word.InsertFileOptions**: Options for inserting a file.
- **Word.InsertShapeOptions**: Options for inserting a shape.
```

--------------------------------

### Word.run(objects, batch)

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=excel-js-1.4

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

```APIDOC
## Word.run(objects, batch)

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

### Parameters
- **objects** (OfficeExtension.ClientObject[]) - Required - An array of previously created API objects. The array will be validated to make sure that all of the objects share the same context.
- **batch** ((context: Word.RequestContext) => Promise<T>) - Required - A function that takes in a RequestContext and returns a promise.

### Response
- **Returns** (Promise<T>) - A promise that resolves when the batch operation completes.
```

--------------------------------

### Word.run(objects, batch)

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=outlook-js-1.1

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

```APIDOC
## Word.run(objects, batch)

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

### Parameters
- **objects** (OfficeExtension.ClientObject[]) - Required - An array of previously created API objects. The array will be validated to make sure that all of the objects share the same context.
- **batch** ((context: Word.RequestContext) => Promise<T>) - Required - A function that takes in a RequestContext and returns a promise.

### Response
- **Returns** (Promise<T>) - A promise that resolves when the batch script completes.
```

--------------------------------

### Word.IndexAddOptions

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=outlook-js-1.12

Represents options for creating an index in a Word document.

```APIDOC
## Word.IndexAddOptions

### Description
Represents options for creating an index in a Word document.

### Method
Not applicable (this is an options object).

### Endpoint
Not applicable (this is an options object).

### Parameters
This object does not have direct parameters. Its fields are used to configure index creation.

### Request Example
```json
{
  "type": "Custom",
  "headingStyles": ["Heading 1", "Heading 2"]
}
```

### Response
This object is used for configuration and does not have a direct response. The response would be from the method used to create an index.
```

--------------------------------

### Word Configuration Options

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=outlook-js-1.14

Overview of various configuration options used for document operations such as sending faxes, reviewing documents, and inserting content.

```APIDOC
## Word Configuration Options

### Description
These objects provide configuration settings for specific methods within the Word JavaScript API, such as document processing and content insertion.

### Available Options
- **Word.DocumentSendFaxOverInternetOptions**: Configuration for Document.sendFaxOverInternet.
- **Word.DocumentSendForReviewOptions**: Configuration for Document.sendForReview.
- **Word.GetTextOptions**: Options for Paragraph.getText.
- **Word.GoToOptions**: Options for Selection.goTo and Document.goTo.
- **Word.HyperlinkAddOptions**: Options for adding to Word.HyperlinkCollection.
- **Word.IndexAddOptions**: Options for creating an index.
- **Word.IndexMarkAllEntriesOptions**: Options for marking all index entries.
- **Word.InsertFileOptions**: Options for inserting a file.
- **Word.InsertShapeOptions**: Options for inserting a shape.
```

--------------------------------

### Word.Interfaces.BookmarkLoadOptions

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=outlook-js-1.12

Represents a single bookmark in a document, selection, or range. The `Bookmark` object is a member of the `Bookmark` collection. The Word.BookmarkCollection includes all the bookmarks listed in the **Bookmark** dialog box (**Insert** menu).

```APIDOC
## Word.Interfaces.BookmarkLoadOptions

### Description
Represents a single bookmark in a document, selection, or range. The `Bookmark` object is a member of the `Bookmark` collection. The Word.BookmarkCollection includes all the bookmarks listed in the **Bookmark** dialog box (**Insert** menu).

### Method
Not applicable (this is an options object).

### Endpoint
Not applicable (this is an options object).

### Parameters
This object does not have direct parameters. Its fields are used to specify which properties of the bookmark to load.

### Request Example
```json
{
  "$select": ["name", "text"]
}
```

### Response
This object is used for configuration and does not have a direct response. The response would be from the method used to load bookmarks.
```

--------------------------------

### Word Method Configuration Options

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=powerpoint-js-1.2

Configuration options for various methods in the Word JavaScript API.

```APIDOC
## Word Method Options

### Description
These interfaces represent configuration options passed to specific methods within the Word JavaScript API.

### Options List
- **List Operations**: `ListFormatCountNumberedItemsOptions`, `ListTemplateAddOptions`, `ListTemplateApplyOptions`
- **Selection Operations**: `SelectionConvertToTableOptions`, `SelectionDeleteOptions`, `SelectionInsertDateTimeOptions`, `SelectionInsertFormulaOptions`, `SelectionInsertSymbolOptions`, `SelectionMoveOptions`, `SelectionMoveLeftRightOptions`, `SelectionMoveStartEndOptions`, `SelectionMoveUpDownOptions`, `SelectionNextOptions`, `SelectionPreviousOptions`
- **XML Operations**: `SelectNodesOptions`, `SelectSingleNodeOptions`
- **Table Operations**: `TableAutoFormatOptions`, `TableCellCollectionSplitOptions`
```

--------------------------------

### Word.CustomXmlPrefixMapping

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=outlook-js-1.1

Represents a `CustomXmlPrefixMapping` object.

```APIDOC
## Word.CustomXmlPrefixMapping

### Description
Represents a `CustomXmlPrefixMapping` object.

### Properties
- **prefix** (string) - Gets or sets the prefix for the namespace mapping.
- **namespaceUri** (string) - Gets or sets the namespace URI for the prefix mapping.
```

--------------------------------

### Setting Interfaces

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=outlook-js-1.9

Interfaces for managing Setting collection data, load options, and update operations.

```APIDOC
## Setting Collection Interfaces

### Description
Provides interfaces for describing data returned by `settingCollection.toJSON()`, specifying load options for `SettingCollection`, and updating data on the `SettingCollection` object.

### Method
N/A (Interface definitions)

### Endpoint
N/A (Interface definitions)

### Parameters
N/A (Interface definitions)

### Request Example
```json
{
  "example": "Word.Interfaces.SettingCollectionData",
  "example": "Word.Interfaces.SettingCollectionLoadOptions",
  "example": "Word.Interfaces.SettingCollectionUpdateData"
}
```

### Response
#### Success Response (200)
- **data** (Word.Interfaces.SettingCollectionData) - The data payload for a SettingCollection.
- **loadOptions** (Word.Interfaces.SettingCollectionLoadOptions) - Options for loading SettingCollection data.
- **updateData** (Word.Interfaces.SettingCollectionUpdateData) - The data payload for updating a SettingCollection.

#### Response Example
```json
{
  "example": "Word.Interfaces.SettingCollectionData"
}
```
```

```APIDOC
## Setting Data Interface

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

### Method
N/A (Interface definitions)

### Endpoint
N/A (Interface definitions)

### Parameters
N/A (Interface definitions)

### Request Example
```json
{
  "example": "Word.Interfaces.SettingData"
}
```

### Response
#### Success Response (200)
- **data** (Word.Interfaces.SettingData) - The data payload for a Setting.

#### Response Example
```json
{
  "example": "Word.Interfaces.SettingData"
}
```
```

```APIDOC
## Setting Load Options Interface

### Description
Represents a setting of the add-in.

### Method
N/A (Interface definitions)

### Endpoint
N/A (Interface definitions)

### Parameters
N/A (Interface definitions)

### Request Example
```json
{
  "example": "Word.Interfaces.SettingLoadOptions"
}
```

### Response
#### Success Response (200)
- **loadOptions** (Word.Interfaces.SettingLoadOptions) - Options for loading Setting data.

#### Response Example
```json
{
  "example": "Word.Interfaces.SettingLoadOptions"
}
```
```

```APIDOC
## Setting Update Data Interface

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

### Method
N/A (Interface definitions)

### Endpoint
N/A (Interface definitions)

### Parameters
N/A (Interface definitions)

### Request Example
```json
{
  "example": "Word.Interfaces.SettingUpdateData"
}
```

### Response
#### Success Response (200)
- **updateData** (Word.Interfaces.SettingUpdateData) - The data payload for updating a Setting.

#### Response Example
```json
{
  "example": "Word.Interfaces.SettingUpdateData"
}
```
```

--------------------------------

### Utility and Context Objects

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=powerpoint-js-1.2

Objects for managing requests, search options, and line numbering.

```APIDOC
## Word.LineNumbering

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

## Word.RequestContext

### Description
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

### Description
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.BorderUniversalCollectionLoadOptions

Source: https://learn.microsoft.com/en-us/javascript/api/word?view=word-js-preview&viewFallbackFrom=outlook-js-1.12

Represents the collection of Word.BorderUniversal objects.

```APIDOC
## Word.Interfaces.BorderUniversalCollectionLoadOptions

### Description
Represents the collection of `Word.BorderUniversal` objects.

### Method
Not applicable (this is an options object).

### Endpoint
Not applicable (this is an options object).

### Parameters
This object does not have direct parameters. Its fields are used to specify which universal border properties to load.

### Request Example
```json
{
  "$select": ["lineStyle", "color", "size"]
}
```

### Response
This object is used for configuration and does not have a direct response. The response would be from the method used to load universal border collections.
```
Tokens:
Raw