Word.Interfaces.DocumentLoadOptions interface

  • Reference
Package:
word

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.

Remarks

[ API set: WordApi 1.1 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
body

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

Specifies the ChangeTracking mode.
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.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

body

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

body?: Word.Interfaces.BodyLoadOptions;

Property Value

Word.Interfaces.BodyLoadOptions

Remarks

[ API set: WordApi 1.1 ]

changeTrackingMode

Specifies the ChangeTracking mode.

changeTrackingMode?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.4 ]

properties

Gets the properties of the document.

properties?: Word.Interfaces.DocumentPropertiesLoadOptions;

Property Value

Word.Interfaces.DocumentPropertiesLoadOptions

Remarks

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

saved?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]