Word.DocumentCreated class

The DocumentCreated object is the top level object created by Application.CreateDocument. A DocumentCreated object is a special Document object.

[ API set: WordApi 1.3 ]

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: WordApiHiddenDocument 1.3 ]

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: WordApiHiddenDocument 1.3 ]

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: WordApiHiddenDocument 1.4 ]

properties

Gets the properties of the document. Read-only.

[ API set: WordApiHiddenDocument 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: WordApiHiddenDocument 1.3 ]

sections

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

[ API set: WordApiHiddenDocument 1.3 ]

settings

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

[ API set: WordApiHiddenDocument 1.4 ]

Methods

deleteBookmark(name)

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

[ API set: WordApiHiddenDocument 1.4 ]

getBookmarkRange(name)

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

[ API set: WordApiHiddenDocument 1.4 ]

getBookmarkRangeOrNullObject(name)

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

[ API set: WordApiHiddenDocument 1.4 ]

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.

open()

Opens the document.

[ API set: WordApi 1.3 ]

save()

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

[ API set: WordApiHiddenDocument 1.3 ]

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.DocumentCreated object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.DocumentCreatedData) 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.

Property Details

body

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 body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.. Read-only.

[ API set: WordApiHiddenDocument 1.3 ]

readonly body: Word.Body;

Property Value

contentControls

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 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: WordApiHiddenDocument 1.3 ]

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: WordApiHiddenDocument 1.4 ]

readonly customXmlParts: Word.CustomXmlPartCollection;

Property Value

properties

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 properties of the document. Read-only.

[ API set: WordApiHiddenDocument 1.3 ]

readonly properties: Word.DocumentProperties;

Property Value

saved

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.

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: WordApiHiddenDocument 1.3 ]

readonly saved: boolean;

Property Value

boolean

sections

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 collection of section objects in the document. Read-only.

[ API set: WordApiHiddenDocument 1.3 ]

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: WordApiHiddenDocument 1.4 ]

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: WordApiHiddenDocument 1.4 ]

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: WordApiHiddenDocument 1.4 ]

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: WordApiHiddenDocument 1.4 ]

getBookmarkRangeOrNullObject(name: string): Word.Range;

Parameters

name
string

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

Returns

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.DocumentCreatedLoadOptions): Word.DocumentCreated;

Parameters

Returns

Remarks

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

load(option?: string | string[]): Word.DocumentCreated - 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.DocumentCreated - 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.DocumentCreated - 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.

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.DocumentCreated;

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.DocumentCreated;

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

open()

Opens the document.

[ API set: WordApi 1.3 ]

open(): void;

Returns

void

save()

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.

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

[ API set: WordApiHiddenDocument 1.3 ]

save(): void;

Returns

void

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.DocumentCreatedUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

properties
Interfaces.DocumentCreatedUpdateData

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.DocumentCreated): void

set(properties)

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

set(properties: Word.DocumentCreated): void;

Parameters

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.DocumentCreated object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.DocumentCreatedData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Word.Interfaces.DocumentCreatedData;

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.DocumentCreated;

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.DocumentCreated;

Returns