Word.Interfaces.DocumentUpdateData interface
An interface for updating data on the Document object, for use in document.set({ ... }).
Properties
| 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 body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. |
| 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. |
Property Details
autoHyphenation
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.
Specifies if automatic hyphenation is turned on for the document.
autoHyphenation?: boolean;Property Value
boolean
Remarks
autoSaveOn
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.
Specifies if the edits in the document are automatically saved.
autoSaveOn?: boolean;Property Value
boolean
Remarks
bibliography
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.
Returns a Bibliography object that represents the bibliography references contained within the document.
bibliography?: Word.Interfaces.BibliographyUpdateData;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.BodyUpdateData;Property Value
Remarks
changeTrackingMode
Specifies the ChangeTracking mode.
changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";Property Value
Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"
Remarks
consecutiveHyphensLimit
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.
Specifies the maximum number of consecutive lines that can end with hyphens.
consecutiveHyphensLimit?: number;Property Value
number
Remarks
hyphenateCaps
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.
Specifies whether words in all capital letters can be hyphenated.
hyphenateCaps?: boolean;Property Value
boolean
Remarks
languageDetected
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.
Specifies whether Microsoft Word has detected the language of the document text.
languageDetected?: boolean;Property Value
boolean
Remarks
pageSetup
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.
Returns a PageSetup object that's associated with the document.
pageSetup?: Word.Interfaces.PageSetupUpdateData;Property Value
Remarks
properties
Gets the properties of the document.
properties?: Word.Interfaces.DocumentPropertiesUpdateData;