Word.Interfaces.DocumentCreatedData interface

An interface describing the data returned by calling "documentCreated.toJSON()".

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 ]

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 ]

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 ]

body?: Word.Interfaces.BodyData;

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 ]

contentControls?: Word.Interfaces.ContentControlData[];

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 ]

customXmlParts?: Word.Interfaces.CustomXmlPartData[];

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 ]

properties?: Word.Interfaces.DocumentPropertiesData;

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 ]

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 ]

sections?: Word.Interfaces.SectionData[];

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 ]

settings?: Word.Interfaces.SettingData[];

Property Value