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.
- Extends
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-change-tracking.yaml
// Gets the current change tracking mode.
await Word.run(async (context) => {
const document: Word.Document = context.document;
document.load("changeTrackingMode");
await context.sync();
if (document.changeTrackingMode === Word.ChangeTrackingMode.trackMineOnly) {
console.log("Only my changes are being tracked.");
} else if (document.changeTrackingMode === Word.ChangeTrackingMode.trackAll) {
console.log("Everyone's changes are being tracked.");
} else {
console.log("No changes are being tracked.");
}
});
Properties
| body | Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. |
| change |
Specifies the ChangeTracking mode. |
| content |
Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. |
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| custom |
Gets the custom XML parts in the document. |
| properties | Gets the properties of the document. |
| 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. |
| sections | Gets the collection of section objects in the document. |
| settings | Gets the add-in's settings in the document. |
Methods
| delete |
Deletes a bookmark, if it exists, from the document. |
| get |
Gets a bookmark's range. Throws an |
| get |
Gets a bookmark's range. If the bookmark doesn't exist, then this method will return an object with its |
| get |
Gets the current selection of the document. Multiple selections aren't supported. |
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| save(save |
Saves the document. |
| save(save |
Saves the document. |
| 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 |
| 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're using this object across |
| 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'll need to call |
Property Details
body
Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.
readonly body: Word.Body;Property Value
Remarks
changeTrackingMode
Specifies the ChangeTracking mode.
changeTrackingMode: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";Property Value
Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-change-tracking.yaml
// Gets the current change tracking mode.
await Word.run(async (context) => {
const document: Word.Document = context.document;
document.load("changeTrackingMode");
await context.sync();
if (document.changeTrackingMode === Word.ChangeTrackingMode.trackMineOnly) {
console.log("Only my changes are being tracked.");
} else if (document.changeTrackingMode === Word.ChangeTrackingMode.trackAll) {
console.log("Everyone's changes are being tracked.");
} else {
console.log("No changes are being tracked.");
}
});
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.
readonly contentControls: Word.ContentControlCollection;Property Value
Remarks
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
Gets the custom XML parts in the document.
readonly customXmlParts: Word.CustomXmlPartCollection;Property Value
Remarks
properties
Gets the properties of the document.
readonly properties: Word.DocumentProperties;Property Value
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/30-properties/get-built-in-properties.yaml
await Word.run(async (context) => {
const builtInProperties: Word.DocumentProperties = 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.
readonly saved: boolean;Property Value
boolean
Remarks
sections
Gets the collection of section objects in the document.
readonly sections: Word.SectionCollection;Property Value
Remarks
settings
Gets the add-in's settings in the document.
readonly settings: Word.SettingCollection;Property Value
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-settings.yaml
// Gets all custom settings this add-in set on this document.
await Word.run(async (context) => {
const settings: Word.SettingCollection = context.document.settings;
settings.load("items");
await context.sync();
if (settings.items.length == 0) {
console.log("There are no settings.");
} else {
console.log("All settings:");
for (let i = 0; i < settings.items.length; i++) {
console.log(settings.items[i]);
}
}
});
Method Details
deleteBookmark(name)
Deletes a bookmark, if it exists, from the document.
deleteBookmark(name: string): void;Parameters
- name
-
string
Required. The case-insensitive bookmark name.
Returns
void
Remarks
getBookmarkRange(name)
Gets a bookmark's range. Throws an ItemNotFound error if the bookmark doesn't exist.
getBookmarkRange(name: string): Word.Range;Parameters
- name
-
string
Required. The case-insensitive bookmark name.
Returns
Remarks
getBookmarkRangeOrNullObject(name)
Gets a bookmark's range. If the bookmark doesn't exist, then this method will return an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
getBookmarkRangeOrNullObject(name: string): Word.Range;Parameters
- name
-
string
Required. The case-insensitive bookmark name.
Returns
Remarks
getSelection()
Gets the current selection of the document. Multiple selections aren't supported.
getSelection(): Word.Range;Returns
Remarks
Examples
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
const 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.
const 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.
await context.sync();
console.log('Inserted the text at the end of the selection.');
});
load(options)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(options?: Word.Interfaces.DocumentLoadOptions): Word.Document;Parameters
Provides options for which properties of the object to load.
Returns
Examples
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Create a proxy object for the document.
const thisDocument = context.document;
// Queue a command to load content control properties.
thisDocument.load('contentControls/id, contentControls/text, contentControls/tag');
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
if (thisDocument.contentControls.items.length !== 0) {
for (let 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.');
}
});
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; }
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(saveBehavior, fileName)
Saves the document.
save(saveBehavior?: Word.SaveBehavior, fileName?: string): void;Parameters
- saveBehavior
- Word.SaveBehavior
Optional. The save behavior must be 'Save' or 'Prompt'. Default value is 'Save'.
- fileName
-
string
Optional. The file name (exclude file extension). Only takes effect for a new document.
Returns
void
Remarks
Note: The saveBehavior and fileName parameters were introduced in WordApi 1.5.
Examples
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Create a proxy object for the document.
const thisDocument = context.document;
// Queue a command to load the document save state (on the saved property).
thisDocument.load('saved');
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
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.
await context.sync();
console.log('Saved the document');
} else {
console.log('The document has not changed since the last save.');
}
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/save-close.yaml
// Saves the document with default behavior
// for current state of the document.
await Word.run(async (context) => {
context.document.save();
await context.sync();
});
save(saveBehaviorString, fileName)
Saves the document.
save(saveBehaviorString?: "Save" | "Prompt", fileName?: string): void;Parameters
- saveBehaviorString
-
"Save" | "Prompt"
Optional. The save behavior must be 'Save' or 'Prompt'. Default value is 'Save'.
- fileName
-
string
Optional. The file name (exclude file extension). Only takes effect for a new document.
Returns
void
Remarks
Note: The saveBehavior and fileName parameters were introduced in WordApi 1.5.
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
- Word.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
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's 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're 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 need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
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'll need to call context.sync() before the memory release takes effect.
untrack(): Word.Document;Returns
Office Add-ins