Word.Interfaces.DocumentLoadOptions interface
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
Properties
| $all | Specifying |
| active |
Gets the active window for the document. |
| attached |
Specifies a |
| auto |
Specifies if automatic hyphenation is turned on for the document. |
| auto |
Specifies if the edits in the document are automatically saved. |
| bibliography | Returns a |
| body | Gets the |
| change |
Specifies the ChangeTracking mode. |
| consecutive |
Specifies the maximum number of consecutive lines that can end with hyphens. |
| hyphenate |
Specifies whether words in all capital letters can be hyphenated. |
| language |
Specifies whether Microsoft Word has detected the language of the document text. |
| page |
Returns a |
| properties | Gets the properties of the document. |
| saved | Indicates whether the changes in the document have been saved. A value of |
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
activeWindow
Gets the active window for the document.
activeWindow?: Word.Interfaces.WindowLoadOptions;Property Value
Remarks
attachedTemplate
Specifies a Template object that represents the template attached to the document.
attachedTemplate?: Word.Interfaces.TemplateLoadOptions;Property Value
Remarks
autoHyphenation
Specifies if automatic hyphenation is turned on for the document.
autoHyphenation?: boolean;Property Value
boolean
Remarks
autoSaveOn
Specifies if the edits in the document are automatically saved.
autoSaveOn?: boolean;Property Value
boolean
Remarks
bibliography
Returns a Bibliography object that represents the bibliography references contained within the document.
bibliography?: Word.Interfaces.BibliographyLoadOptions;Property Value
Remarks
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
Remarks
changeTrackingMode
Specifies the ChangeTracking mode.
changeTrackingMode?: boolean;Property Value
boolean
Remarks
consecutiveHyphensLimit
Specifies the maximum number of consecutive lines that can end with hyphens.
consecutiveHyphensLimit?: boolean;Property Value
boolean
Remarks
hyphenateCaps
Specifies whether words in all capital letters can be hyphenated.
hyphenateCaps?: boolean;Property Value
boolean
Remarks
languageDetected
Specifies whether Microsoft Word has detected the language of the document text.
languageDetected?: boolean;Property Value
boolean
Remarks
pageSetup
Returns a PageSetup object that's associated with the document.
pageSetup?: Word.Interfaces.PageSetupLoadOptions;Property Value
Remarks
properties
Gets the properties of the document.
properties?: Word.Interfaces.DocumentPropertiesLoadOptions;Property Value
Remarks
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