Edit

Share via

Word.Interfaces.DocumentData interface

  • Reference
Package:
word

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

Properties

body

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

Property Details

body

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

body?: Word.Interfaces.BodyData;

Property Value

Word.Interfaces.BodyData

Remarks

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

contentControls?: Word.Interfaces.ContentControlData[];

Property Value

Word.Interfaces.ContentControlData[]

Remarks

[ API set: WordApi 1.1 ]

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.

saved?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

sections

Gets the collection of section objects in the document.

sections?: Word.Interfaces.SectionData[];

Property Value

Word.Interfaces.SectionData[]

Remarks

[ API set: WordApi 1.1 ]