Word.Interfaces.DocumentLoadOptions interface

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`).
activeTheme	Gets the name of the active theme and formatting options.
activeThemeDisplayName	Gets the display name of the active theme.
activeWindow	Gets the active window for the document.
areFilePropertiesPasswordEncrypted	Gets whether Word encrypts file properties for password-protected documents.
areGrammaticalErrorsShown	Specifies whether grammatical errors are marked by a wavy green line in the document.
areMathDefaultsUsed	Specifies whether to use the default math settings when creating new equations.
areNewerFeaturesDisabled	Specifies whether to disable features introduced after a specified version.
areSpellingErrorsShown	Specifies whether Microsoft Word underlines spelling errors in the document.
areStylesUpdatedOnOpen	Specifies whether the styles in this document are updated to match the styles in the attached template each time the document is opened.
areTrueTypeFontsEmbedded	Specifies whether Microsoft Word embeds TrueType fonts in the document when it's saved.
attachedTemplate	Specifies a `Template` object that represents the template attached to the document.
autoHyphenation	Specifies if automatic hyphenation is turned on for the document.
autoSaveOn	Specifies if the edits in the document are automatically saved.
background	Gets a `Shape` object that represents the background image for the document.
bibliography	Returns a `Bibliography` object that represents the bibliography references contained within the document.
body	Gets the `Body` object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.
builtInDocumentProperties	Gets a `DocumentProperties` object that represents all the built-in document properties for the document.
changeTrackingMode	Specifies the ChangeTracking mode.
coauthoring	Gets a `Coauthoring` object for managing coauthoring in the document.
codeName	Gets the code name for the document.
compatibilityMode	Gets the compatibility mode that Word uses when opening the document.
consecutiveHyphensLimit	Specifies the maximum number of consecutive lines that can end with hyphens.
content	Gets a `Range` object that represents the main document story.
currentRsid	Gets a random number that Word assigns to changes in the document.
customDocumentProperties	Gets a `DocumentProperties` collection that represents all the custom document properties for the document.
defaultTabStop	Specifies the interval (in points) between the default tab stops in the document.
defaultTargetFrame	Specifies the browser frame for displaying a webpage via hyperlink.
doNotEmbedSystemFonts	Specifies whether Word should not embed common system fonts.
encryptionProvider	Specifies the name of the algorithm encryption provider that Microsoft Word uses when encrypting documents.
farEastLineBreakLanguage	Specifies the East Asian language used for line breaking.
farEastLineBreakLevel	Specifies the line break control level.
formattingIsNextLevelShown	Specifies whether Word shows the next heading level when the previous is used.
formattingIsUserStyleNameShown	Specifies whether to show user-defined styles.
fullName	Gets the name of a document, including the path.
gridDistanceHorizontal	Specifies the horizontal space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document.
gridDistanceVertical	Specifies the vertical space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document.
gridIsOriginFromMargin	Specifies whether the character grid starts from the upper-left corner of the page.
gridOriginHorizontal	Specifies the horizontal origin point for the invisible grid.
gridOriginVertical	Specifies the vertical origin point for the invisible grid.
gridSpaceBetweenHorizontalLines	Specifies the interval for horizontal character gridlines in print layout view.
gridSpaceBetweenVerticalLines	Specifies the interval for vertical character gridlines in print layout view.
hasPassword	Gets whether a password is required to open the document.
hasVbProject	Gets whether the document has an attached Microsoft Visual Basic for Applications project.
hyphenateCaps	Specifies whether words in all capital letters can be hyphenated.
hyphenationZone	Specifies the width of the hyphenation zone, in points.
isAutoFormatOverrideOn	Specifies whether automatic formatting options override formatting restrictions.
isChartDataPointTracked	Specifies whether charts in the active document use cell-reference data-point tracking.
isCompatible	Specifies whether the compatibility option specified by the `type` property is enabled.
isFinal	Specifies whether the document is final.
isFontsSubsetSaved	Specifies whether Microsoft Word saves a subset of the embedded TrueType fonts with the document.
isFormsDataPrinted	Specifies whether Microsoft Word prints onto a preprinted form only the data entered in the corresponding online form.
isFormsDataSaved	Specifies whether Microsoft Word saves the data entered in a form as a tab-delimited record for use in a database.
isGrammarChecked	Specifies whether a grammar check has been run on the document.
isInAutoSave	Gets whether the most recent firing of the `Application.DocumentBeforeSave` event was the result of an automatic save by the document or a manual save by the user.
isInFormsDesign	Gets whether the document is in form design mode.
isKerningByAlgorithm	Specifies whether Word kerns half-width Latin characters and punctuation marks.
isLinguisticDataEmbedded	Specifies whether to embed speech and handwriting data.
isMasterDocument	Gets whether this document is a master document.
isOptimizedForWord97	Specifies whether Word optimizes the document for Word 97.
isPostScriptPrintedOverText	Specifies whether PRINT field instructions (such as PostScript commands) in the document are to be printed on top of text and graphics when a PostScript printer is used.
isQuickStyleSetLocked	Specifies whether users can change the Quick Style set.
isReadOnly	Gets whether changes to the document cannot be saved to the original document.
isReadOnlyRecommended	Specifies whether Microsoft Word displays a message box whenever a user opens the document, suggesting that it be opened as read-only.
isSnappedToGrid	Specifies whether AutoShapes or East Asian characters are automatically aligned with an invisible grid.
isSnappedToShapes	Specifies whether AutoShapes or East Asian characters align with invisible gridlines through other shapes.
isSpellingChecked	Specifies whether spelling has been checked throughout the document.
isStyleEnforced	Specifies whether formatting restrictions are enforced in a protected document.
isSubdocument	Gets whether this document is a subdocument of a master document.
isThemeLocked	Specifies whether users can change the document theme.
isUserControl	Specifies whether the document was created or opened by the user.
isVbaSigned	Gets whether the VBA project is digitally signed.
isWriteReserved	Gets whether the document is protected with a write password.
justificationMode	Specifies the character spacing adjustment.
kind	Specifies the format type that Microsoft Word uses when automatically formatting the document.
languageDetected	Specifies whether Microsoft Word has detected the language of the document text.
noLineBreakAfter	Specifies the kinsoku characters after which Word will not break a line.
noLineBreakBefore	Specifies the kinsoku characters before which Word will not break a line.
openEncoding	Gets the encoding used to open the document.
originalDocumentTitle	Gets the title of the original document after legal-blackline comparison.
pageSetup	Returns a `PageSetup` object that's associated with the document.
password	Sets a password that must be supplied to open the document.
passwordEncryptionAlgorithm	Gets the algorithm used for password encryption.
passwordEncryptionKeyLength	Gets the key length used for password encryption.
passwordEncryptionProvider	Gets the name of the password encryption provider.
path	Gets the disk or the web path to the document (excludes the document name).
printRevisions	Specifies whether revision marks are printed with the document.
properties	Gets the properties of the document.
protectionType	Gets the protection type for the document.
readingLayoutSizeX	Specifies the width of pages in reading layout view when frozen.
readingLayoutSizeY	Specifies the height of pages in reading layout view when frozen.
readingModeIsLayoutFrozen	Specifies whether pages in reading layout view are frozen for handwritten markup.
removePersonalInformationOnSave	Specifies whether Word removes user information upon saving.
revisedDocumentTitle	Gets the title of the revised document after legal-blackline comparison.
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.
saveEncoding	Specifies the encoding used when saving the document.
saveFormat	Gets the file format of the document.
selection	Returns a `Selection` object that represents the current selection in the document.
textEncoding	Specifies the encoding for saving as encoded text.
textLineEnding	Specifies how Word marks line and paragraph breaks in text files.
trackedChangesAreDateAndTimeRemoved	Specifies whether to remove or store date and time metadata for tracked changes.
trackFormatting	Specifies whether to track formatting changes when change tracking is on.
trackMoves	Specifies whether to mark moved text when Track Changes is on.
trackRevisions	Specifies whether changes are tracked in the document.
type	Gets the document type (template or document).
webSettings	Gets the `WebSettings` object for webpage-related attributes.
writePassword	Sets a password for saving changes to the document.
xmlAreAdvancedErrorsShown	Specifies whether error messages are generated from built-in Word messages or MSXML (Microsoft XML).
xmlIsXsltUsedWhenSaving	Specifies whether to save a document through an Extensible Stylesheet Language Transformation (XSLT).
xmlSaveThroughXslt	Specifies the path and file name for the XSLT to apply when saving a document.

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

activeTheme

Gets the name of the active theme and formatting options.

activeTheme?: boolean;

Property Value

boolean

Share via

Word.Interfaces.DocumentLoadOptions interface

Remarks

Properties

Property Details

$all

Property Value

activeTheme

Property Value

Remarks

activeThemeDisplayName

Property Value

Remarks

activeWindow

Property Value

Remarks

areFilePropertiesPasswordEncrypted

Property Value

Remarks

areGrammaticalErrorsShown

Property Value

Remarks

areMathDefaultsUsed

Property Value

Remarks

areNewerFeaturesDisabled

Property Value

Remarks

areSpellingErrorsShown

Property Value

Remarks

areStylesUpdatedOnOpen

Property Value

Remarks

areTrueTypeFontsEmbedded

Property Value

Remarks

attachedTemplate

Property Value

Remarks

autoHyphenation

Property Value

Remarks

autoSaveOn

Property Value

Remarks

background

Property Value

Remarks

bibliography

Property Value

Remarks

body

Property Value

Remarks

builtInDocumentProperties

Property Value

Remarks

changeTrackingMode

Property Value

Remarks

coauthoring

Property Value

Remarks

codeName

Property Value

Remarks

compatibilityMode

Property Value

Remarks

consecutiveHyphensLimit

Property Value

Remarks

content

Property Value

Remarks

currentRsid

Property Value

Remarks

customDocumentProperties