Word.Document class

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.

[ API set: WordApi 1.1 ]

Extends
OfficeExtension.ClientObject

Properties

body

Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.. Read-only.

[ API set: WordApi 1.1 ]

contentControls

Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc.. Read-only.

[ API set: WordApi 1.1 ]

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

customXmlParts

Gets the custom XML parts in the document. Read-only.

[ API set: WordApi BETA (PREVIEW ONLY) ]

properties

Gets the properties of the document. Read-only.

[ API set: WordApi 1.3 ]

saved

Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. Read-only.

[ API set: WordApi 1.1 ]

sections

Gets the collection of section objects in the document. Read-only.

[ API set: WordApi 1.1 ]

settings

Gets the add-in's settings in the document. Read-only.

[ API set: WordApi BETA (PREVIEW ONLY) ]

Methods

deleteBookmark(name)

Deletes a bookmark, if it exists, from the document.

[ API set: WordApi BETA (PREVIEW ONLY) ]

getBookmarkRange(name)

Gets a bookmark's range. Throws an error if the bookmark does not exist.

[ API set: WordApi BETA (PREVIEW ONLY) ]

getBookmarkRangeOrNullObject(name)

Gets a bookmark's range. Returns a null object if the bookmark does not exist.

[ API set: WordApi BETA (PREVIEW ONLY) ]

getSelection()

Gets the current selection of the document. Multiple selections are not supported.

[ API set: WordApi 1.1 ]

load(option)

Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

save()

Saves the document. This uses the Word default file naming convention if the document has not been saved before.

[ API set: WordApi 1.1 ]

set(properties, options)

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Word.Document object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.DocumentData) that contains shallow copies of any loaded child properties from the original object.

track()

Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.

untrack()

Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.

Events

onContentControlAdded

Occurs when a content control is added. Run context.sync() in the handler to get the new content control's properties.

[ API set: WordApi BETA (PREVIEW ONLY) ]

Property Details

body

Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.. Read-only.

[ API set: WordApi 1.1 ]

readonly body: Word.Body;

Property Value

contentControls

Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc.. Read-only.

[ API set: WordApi 1.1 ]

readonly contentControls: Word.ContentControlCollection;

Property Value

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

customXmlParts

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the custom XML parts in the document. Read-only.

[ API set: WordApi BETA (PREVIEW ONLY) ]

readonly customXmlParts: Word.CustomXmlPartCollection;

Property Value

properties

Gets the properties of the document. Read-only.

[ API set: WordApi 1.3 ]

readonly properties: Word.DocumentProperties;

Property Value

Examples

await Word.run(async (context) => {
    let builtInProperties = context.document.properties;
    builtInProperties.load("*"); // Let's get all!

    await context.sync();
    console.log(JSON.stringify(builtInProperties, null, 4));
});

saved

Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. Read-only.

[ API set: WordApi 1.1 ]

readonly saved: boolean;

Property Value

boolean

sections

Gets the collection of section objects in the document. Read-only.

[ API set: WordApi 1.1 ]

readonly sections: Word.SectionCollection;

Property Value

settings

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the add-in's settings in the document. Read-only.

[ API set: WordApi BETA (PREVIEW ONLY) ]

readonly settings: Word.SettingCollection;

Property Value

Method Details

deleteBookmark(name)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Deletes a bookmark, if it exists, from the document.

[ API set: WordApi BETA (PREVIEW ONLY) ]

deleteBookmark(name: string): void;

Parameters

name
string

Required. The bookmark name, which is case-insensitive.

Returns

void

getBookmarkRange(name)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets a bookmark's range. Throws an error if the bookmark does not exist.

[ API set: WordApi BETA (PREVIEW ONLY) ]

getBookmarkRange(name: string): Word.Range;

Parameters

name
string

Required. The bookmark name, which is case-insensitive.

Returns

getBookmarkRangeOrNullObject(name)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets a bookmark's range. Returns a null object if the bookmark does not exist.

[ API set: WordApi BETA (PREVIEW ONLY) ]

getBookmarkRangeOrNullObject(name: string): Word.Range;

Parameters

name
string

Required. The bookmark name, which is case-insensitive.

Returns

getSelection()

Gets the current selection of the document. Multiple selections are not supported.

[ API set: WordApi 1.1 ]

getSelection(): Word.Range;

Returns

Examples

// Run a batch operation against the Word object model.
Word.run(function (context) {
    
    var textSample = 'This is an example of the insert text method. This is a method ' + 
        'which allows users to insert text into a selection. It can insert text into a ' +
        'relative location or it can overwrite the current selection. Since the ' +
        'getSelection method returns a range object, look up the range object documentation ' +
        'for everything you can do with a selection.';
    
    // Create a range proxy object for the current selection.
    var range = context.document.getSelection();
    
    // Queue a command to insert text at the end of the selection.
    range.insertText(textSample, Word.InsertLocation.end);
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    return context.sync().then(function () {
        console.log('Inserted the text at the end of the selection.');
    });  
})
.catch(function (error) {
    console.log('Error: ' + JSON.stringify(error));
    if (error instanceof OfficeExtension.Error) {
        console.log('Debug info: ' + JSON.stringify(error.debugInfo));
    }
});

load(option)

Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.

load(option?: Word.Interfaces.DocumentLoadOptions): Word.Document;

Parameters

Returns

Remarks

In addition to this signature, this method has the following signatures:

load(option?: string | string[]): Word.Document - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Word.Document - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Word.Document - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items.

Examples

// Run a batch operation against the Word object model.
Word.run(function (context) {
    
    // Create a proxy object for the document.
    var thisDocument = context.document;
    
    // Queue a command to load content control properties.
    context.load(thisDocument, 'contentControls/id, contentControls/text, contentControls/tag');
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    return context.sync().then(function () {
        if (thisDocument.contentControls.items.length !== 0) {
            for (var i = 0; i < thisDocument.contentControls.items.length; i++) {
                console.log(thisDocument.contentControls.items[i].id);
                console.log(thisDocument.contentControls.items[i].text);
                console.log(thisDocument.contentControls.items[i].tag);
            }
        } else {
            console.log('No content controls in this document.');
        }
    });  
})
.catch(function (error) {
    console.log('Error: ' + JSON.stringify(error));
    if (error instanceof OfficeExtension.Error) {
        console.log('Debug info: ' + JSON.stringify(error.debugInfo));
    }
});

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): Word.Document;

Parameters

propertyNames
string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Word.Document;

Parameters

propertyNamesAndPaths
{ select?: string; expand?: string; }

Where propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

Returns

save()

Saves the document. This uses the Word default file naming convention if the document has not been saved before.

[ API set: WordApi 1.1 ]

save(): void;

Returns

void

Examples

// Run a batch operation against the Word object model.
Word.run(function (context) {
    
    // Create a proxy object for the document.
    var thisDocument = context.document;

    // Queue a command to load the document save state (on the saved property).
    context.load(thisDocument, 'saved');    
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    return context.sync().then(function () {
        
        if (thisDocument.saved === false) {
            // Queue a command to save this document.
            thisDocument.save();
            
            // Synchronize the document state by executing the queued commands, 
            // and return a promise to indicate task completion.
            return context.sync().then(function () {
                console.log('Saved the document');
            });
        } else {
            console.log('The document has not changed since the last save.');
        }
    });  
})
.catch(function (error) {
    console.log("Error: " + JSON.stringify(error));
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

set(properties, options)

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.DocumentUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

properties
Interfaces.DocumentUpdateData

A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

Provides an option to suppress errors if the properties object tries to set any read-only properties.

Returns

void

Remarks

This method has the following additional signature:

set(properties: Word.Document): void

set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Word.Document): void;

Parameters

properties
Word.Document

Returns

void

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Word.Document object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.DocumentData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Word.Interfaces.DocumentData;

Returns

track()

Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you are using this object across ".sync" calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you needed to have added the object to the tracked object collection when the object was first created.

track(): Word.Document;

Returns

untrack()

Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You will need to call "context.sync()" before the memory release takes effect.

untrack(): Word.Document;

Returns

Event Details

onContentControlAdded

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Occurs when a content control is added. Run context.sync() in the handler to get the new content control's properties.

[ API set: WordApi BETA (PREVIEW ONLY) ]

readonly onContentControlAdded: OfficeExtension.EventHandlers<Word.ContentControlEventArgs>;

Returns

OfficeExtension.EventHandlers<Word.ContentControlEventArgs>