Word.Interfaces.DocumentData interface
An interface describing the data returned by calling document.toJSON().
Properties
| active |
Gets the name of the active theme and formatting options. |
| active |
Gets the display name of the active theme. |
| active |
Gets the active window for the document. |
| are |
Gets whether Word encrypts file properties for password-protected documents. |
| are |
Specifies whether grammatical errors are marked by a wavy green line in the document. |
| are |
Specifies whether to use the default math settings when creating new equations. |
| are |
Specifies whether to disable features introduced after a specified version. |
| are |
Specifies whether Microsoft Word underlines spelling errors in the document. |
| are |
Specifies whether the styles in this document are updated to match the styles in the attached template each time the document is opened. |
| are |
Specifies whether Microsoft Word embeds TrueType fonts in the document when it's saved. |
| 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. |
| coauthoring | Gets a |
| code |
Gets the code name for the document. |
| compatibility |
Gets the compatibility mode that Word uses when opening the document. |
| consecutive |
Specifies the maximum number of consecutive lines that can end with hyphens. |
| content |
Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. |
| current |
Gets a random number that Word assigns to changes in the document. |
| custom |
Gets the custom XML parts in the document. |
| default |
Specifies the interval (in points) between the default tab stops in the document. |
| default |
Specifies the browser frame for displaying a webpage via hyperlink. |
| document |
Returns a |
| do |
Specifies whether Word should not embed common system fonts. |
| encryption |
Specifies the name of the algorithm encryption provider that Microsoft Word uses when encrypting documents. |
| far |
Specifies the East Asian language used for line breaking. |
| far |
Specifies the line break control level. |
| formatting |
Specifies whether Word shows the next heading level when the previous is used. |
| formatting |
Specifies whether to show user-defined styles. |
| frames | Returns a |
| full |
Gets the name of a document, including the path. |
| grid |
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. |
| grid |
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. |
| grid |
Specifies whether the character grid starts from the upper-left corner of the page. |
| grid |
Specifies the horizontal origin point for the invisible grid. |
| grid |
Specifies the vertical origin point for the invisible grid. |
| grid |
Specifies the interval for horizontal character gridlines in print layout view. |
| grid |
Specifies the interval for vertical character gridlines in print layout view. |
| has |
Gets whether a password is required to open the document. |
| has |
Gets whether the document has an attached Microsoft Visual Basic for Applications project. |
| hyperlinks | Returns a |
| hyphenate |
Specifies whether words in all capital letters can be hyphenated. |
| hyphenation |
Specifies the width of the hyphenation zone, in points. |
| is |
Specifies whether automatic formatting options override formatting restrictions. |
| is |
Specifies whether charts in the active document use cell-reference data-point tracking. |
| is |
Specifies whether the compatibility option specified by the |
| is |
Specifies whether the document is final. |
| is |
Specifies whether Microsoft Word saves a subset of the embedded TrueType fonts with the document. |
| is |
Specifies whether Microsoft Word prints onto a preprinted form only the data entered in the corresponding online form. |
| is |
Specifies whether Microsoft Word saves the data entered in a form as a tab-delimited record for use in a database. |
| is |
Specifies whether a grammar check has been run on the document. |
| is |
Gets whether the most recent firing of the |
| is |
Gets whether the document is in form design mode. |
| is |
Specifies whether Word kerns half-width Latin characters and punctuation marks. |
| is |
Specifies whether to embed speech and handwriting data. |
| is |
Gets whether this document is a master document. |
| is |
Specifies whether Word optimizes the document for Word 97. |
| is |
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. |
| is |
Specifies whether users can change the Quick Style set. |
| is |
Gets whether changes to the document cannot be saved to the original document. |
| is |
Specifies whether Microsoft Word displays a message box whenever a user opens the document, suggesting that it be opened as read-only. |
| is |
Specifies whether AutoShapes or East Asian characters are automatically aligned with an invisible grid. |
| is |
Specifies whether AutoShapes or East Asian characters align with invisible gridlines through other shapes. |
| is |
Specifies whether spelling has been checked throughout the document. |
| is |
Specifies whether formatting restrictions are enforced in a protected document. |
| is |
Gets whether this document is a subdocument of a master document. |
| is |
Specifies whether users can change the document theme. |
| is |
Specifies whether the document was created or opened by the user. |
| is |
Gets whether the VBA project is digitally signed. |
| is |
Gets whether the document is protected with a write password. |
| justification |
Specifies the character spacing adjustment. |
| kind | Specifies the format type that Microsoft Word uses when automatically formatting the document. |
| language |
Specifies whether Microsoft Word has detected the language of the document text. |
| list |
Returns a |
| no |
Specifies the kinsoku characters after which Word will not break a line. |
| no |
Specifies the kinsoku characters before which Word will not break a line. |
| open |
Gets the encoding used to open the document. |
| original |
Gets the title of the original document after legal-blackline comparison. |
| page |
Returns a |
| password | Sets a password that must be supplied to open the document. |
| password |
Gets the algorithm used for password encryption. |
| password |
Gets the key length used for password encryption. |
| password |
Gets the name of the password encryption provider. |
| path | Gets the disk or the web path to the document (excludes the document name). |
| print |
Specifies whether revision marks are printed with the document. |
| properties | Gets the properties of the document. |
| protection |
Gets the protection type for the document. |
| reading |
Specifies the width of pages in reading layout view when frozen. |
| reading |
Specifies the height of pages in reading layout view when frozen. |
| reading |
Specifies whether pages in reading layout view are frozen for handwritten markup. |
| remove |
Specifies whether Word removes user information upon saving. |
| revised |
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. |
| save |
Specifies the encoding used when saving the document. |
| save |
Gets the file format of the document. |
| sections | Gets the collection of section objects in the document. |
| selection | Returns a |
| settings | Gets the add-in's settings in the document. |
| text |
Specifies the encoding for saving as encoded text. |
| text |
Specifies how Word marks line and paragraph breaks in text files. |
| tracked |
Specifies whether to remove or store date and time metadata for tracked changes. |
| track |
Specifies whether to track formatting changes when change tracking is on. |
| track |
Specifies whether to mark moved text when Track Changes is on. |
| track |
Specifies whether changes are tracked in the document. |
| type | Gets the document type (template or document). |
| windows | Gets the collection of |
| write |
Sets a password for saving changes to the document. |
| xml |
Specifies whether error messages are generated from built-in Word messages or MSXML (Microsoft XML). |
| xml |
Specifies whether to save a document through an Extensible Stylesheet Language Transformation (XSLT). |
| xml |
Specifies the path and file name for the XSLT to apply when saving a document. |
Property Details
activeTheme
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.
Gets the name of the active theme and formatting options.
activeTheme?: string;Property Value
string
Remarks
activeThemeDisplayName
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.
Gets the display name of the active theme.
activeThemeDisplayName?: string;Property Value
string
Remarks
activeWindow
Gets the active window for the document.
activeWindow?: Word.Interfaces.WindowData;Property Value
Remarks
areFilePropertiesPasswordEncrypted
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.
Gets whether Word encrypts file properties for password-protected documents.
areFilePropertiesPasswordEncrypted?: boolean;Property Value
boolean
Remarks
areGrammaticalErrorsShown
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 grammatical errors are marked by a wavy green line in the document.
areGrammaticalErrorsShown?: boolean;Property Value
boolean
Remarks
areMathDefaultsUsed
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 to use the default math settings when creating new equations.
areMathDefaultsUsed?: boolean;Property Value
boolean
Remarks
areNewerFeaturesDisabled
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 to disable features introduced after a specified version.
areNewerFeaturesDisabled?: boolean;Property Value
boolean
Remarks
areSpellingErrorsShown
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 underlines spelling errors in the document.
areSpellingErrorsShown?: boolean;Property Value
boolean
Remarks
areStylesUpdatedOnOpen
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 the styles in this document are updated to match the styles in the attached template each time the document is opened.
areStylesUpdatedOnOpen?: boolean;Property Value
boolean
Remarks
areTrueTypeFontsEmbedded
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 embeds TrueType fonts in the document when it's saved.
areTrueTypeFontsEmbedded?: boolean;Property Value
boolean
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.BibliographyData;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.BodyData;Property Value
Remarks
changeTrackingMode
Specifies the ChangeTracking mode.
changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";Property Value
Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"
Remarks
coauthoring
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.
Gets a Coauthoring object for managing coauthoring in the document.
coauthoring?: Word.Interfaces.CoauthoringData;Property Value
Remarks
codeName
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.
Gets the code name for the document.
codeName?: string;Property Value
string
Remarks
compatibilityMode
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.
Gets the compatibility mode that Word uses when opening the document.
compatibilityMode?: Word.CompatibilityMode | "Word2003" | "Word2007" | "Word2010" | "Word2013" | "Current";Property Value
Word.CompatibilityMode | "Word2003" | "Word2007" | "Word2010" | "Word2013" | "Current"
Remarks
consecutiveHyphensLimit
Specifies the maximum number of consecutive lines that can end with hyphens.
consecutiveHyphensLimit?: number;Property Value
number
Remarks
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
Remarks
currentRsid
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.
Gets a random number that Word assigns to changes in the document.
currentRsid?: number;Property Value
number
Remarks
customXmlParts
Gets the custom XML parts in the document.
customXmlParts?: Word.Interfaces.CustomXmlPartData[];Property Value
Remarks
defaultTabStop
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 interval (in points) between the default tab stops in the document.
defaultTabStop?: number;Property Value
number
Remarks
defaultTargetFrame
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 browser frame for displaying a webpage via hyperlink.
defaultTargetFrame?: string;Property Value
string
Remarks
documentLibraryVersions
Returns a DocumentLibraryVersionCollection object that represents the collection of versions of a shared document that has versioning enabled and that's stored in a document library on a server.
documentLibraryVersions?: Word.Interfaces.DocumentLibraryVersionData[];Property Value
Remarks
doNotEmbedSystemFonts
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 Word should not embed common system fonts.
doNotEmbedSystemFonts?: boolean;Property Value
boolean
Remarks
encryptionProvider
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 name of the algorithm encryption provider that Microsoft Word uses when encrypting documents.
encryptionProvider?: string;Property Value
string
Remarks
farEastLineBreakLanguage
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 East Asian language used for line breaking.
farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese";Property Value
Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"
Remarks
farEastLineBreakLevel
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 line break control level.
farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom";Property Value
Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"
Remarks
formattingIsNextLevelShown
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 Word shows the next heading level when the previous is used.
formattingIsNextLevelShown?: boolean;Property Value
boolean
Remarks
formattingIsUserStyleNameShown
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 to show user-defined styles.
formattingIsUserStyleNameShown?: boolean;Property Value
boolean
Remarks
frames
Returns a FrameCollection object that represents all the frames in the document.
frames?: Word.Interfaces.FrameData[];Property Value
Remarks
fullName
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.
Gets the name of a document, including the path.
fullName?: string;Property Value
string
Remarks
gridDistanceHorizontal
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 horizontal space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document.
gridDistanceHorizontal?: number;Property Value
number
Remarks
gridDistanceVertical
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 vertical space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document.
gridDistanceVertical?: number;Property Value
number
Remarks
gridIsOriginFromMargin
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 the character grid starts from the upper-left corner of the page.
gridIsOriginFromMargin?: boolean;Property Value
boolean
Remarks
gridOriginHorizontal
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 horizontal origin point for the invisible grid.
gridOriginHorizontal?: number;Property Value
number
Remarks
gridOriginVertical
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 vertical origin point for the invisible grid.
gridOriginVertical?: number;Property Value
number
Remarks
gridSpaceBetweenHorizontalLines
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 interval for horizontal character gridlines in print layout view.
gridSpaceBetweenHorizontalLines?: number;Property Value
number
Remarks
gridSpaceBetweenVerticalLines
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 interval for vertical character gridlines in print layout view.
gridSpaceBetweenVerticalLines?: number;Property Value
number
Remarks
hasPassword
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.
Gets whether a password is required to open the document.
hasPassword?: boolean;Property Value
boolean
Remarks
hasVbProject
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.
Gets whether the document has an attached Microsoft Visual Basic for Applications project.
hasVbProject?: boolean;Property Value
boolean
Remarks
hyperlinks
Returns a HyperlinkCollection object that represents all the hyperlinks in the document.
hyperlinks?: Word.Interfaces.HyperlinkData[];Property Value
Remarks
hyphenateCaps
Specifies whether words in all capital letters can be hyphenated.
hyphenateCaps?: boolean;Property Value
boolean
Remarks
hyphenationZone
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 width of the hyphenation zone, in points.
hyphenationZone?: number;Property Value
number
Remarks
isAutoFormatOverrideOn
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 automatic formatting options override formatting restrictions.
isAutoFormatOverrideOn?: boolean;Property Value
boolean
Remarks
isChartDataPointTracked
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 charts in the active document use cell-reference data-point tracking.
isChartDataPointTracked?: boolean;Property Value
boolean
Remarks
isCompatible
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 the compatibility option specified by the type property is enabled.
isCompatible?: boolean;Property Value
boolean
Remarks
isFinal
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 the document is final.
isFinal?: boolean;Property Value
boolean
Remarks
isFontsSubsetSaved
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 saves a subset of the embedded TrueType fonts with the document.
isFontsSubsetSaved?: boolean;Property Value
boolean
Remarks
isFormsDataPrinted
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 prints onto a preprinted form only the data entered in the corresponding online form.
isFormsDataPrinted?: boolean;Property Value
boolean
Remarks
isFormsDataSaved
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 saves the data entered in a form as a tab-delimited record for use in a database.
isFormsDataSaved?: boolean;Property Value
boolean
Remarks
isGrammarChecked
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 a grammar check has been run on the document.
isGrammarChecked?: boolean;Property Value
boolean
Remarks
isInAutoSave
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.
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.
isInAutoSave?: boolean;Property Value
boolean
Remarks
isInFormsDesign
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.
Gets whether the document is in form design mode.
isInFormsDesign?: boolean;Property Value
boolean
Remarks
isKerningByAlgorithm
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 Word kerns half-width Latin characters and punctuation marks.
isKerningByAlgorithm?: boolean;Property Value
boolean
Remarks
isLinguisticDataEmbedded
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 to embed speech and handwriting data.
isLinguisticDataEmbedded?: boolean;Property Value
boolean
Remarks
isMasterDocument
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.
Gets whether this document is a master document.
isMasterDocument?: boolean;Property Value
boolean
Remarks
isOptimizedForWord97
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 Word optimizes the document for Word 97.
isOptimizedForWord97?: boolean;Property Value
boolean
Remarks
isPostScriptPrintedOverText
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 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.
isPostScriptPrintedOverText?: boolean;Property Value
boolean
Remarks
isQuickStyleSetLocked
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 users can change the Quick Style set.
isQuickStyleSetLocked?: boolean;Property Value
boolean
Remarks
isReadOnly
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.
Gets whether changes to the document cannot be saved to the original document.
isReadOnly?: boolean;Property Value
boolean
Remarks
isReadOnlyRecommended
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 displays a message box whenever a user opens the document, suggesting that it be opened as read-only.
isReadOnlyRecommended?: boolean;Property Value
boolean
Remarks
isSnappedToGrid
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 AutoShapes or East Asian characters are automatically aligned with an invisible grid.
isSnappedToGrid?: boolean;Property Value
boolean
Remarks
isSnappedToShapes
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 AutoShapes or East Asian characters align with invisible gridlines through other shapes.
isSnappedToShapes?: boolean;Property Value
boolean
Remarks
isSpellingChecked
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 spelling has been checked throughout the document.
isSpellingChecked?: boolean;Property Value
boolean
Remarks
isStyleEnforced
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 formatting restrictions are enforced in a protected document.
isStyleEnforced?: boolean;Property Value
boolean
Remarks
isSubdocument
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.
Gets whether this document is a subdocument of a master document.
isSubdocument?: boolean;Property Value
boolean
Remarks
isThemeLocked
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 users can change the document theme.
isThemeLocked?: boolean;Property Value
boolean
Remarks
isUserControl
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 the document was created or opened by the user.
isUserControl?: boolean;Property Value
boolean
Remarks
isVbaSigned
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.
Gets whether the VBA project is digitally signed.
isVbaSigned?: boolean;Property Value
boolean
Remarks
isWriteReserved
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.
Gets whether the document is protected with a write password.
isWriteReserved?: boolean;Property Value
boolean
Remarks
justificationMode
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 character spacing adjustment.
justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana";Property Value
Word.JustificationMode | "Expand" | "Compress" | "CompressKana"
Remarks
kind
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 format type that Microsoft Word uses when automatically formatting the document.
kind?: Word.DocumentKind | "NotSpecified" | "Letter" | "Email";Property Value
Word.DocumentKind | "NotSpecified" | "Letter" | "Email"
Remarks
languageDetected
Specifies whether Microsoft Word has detected the language of the document text.
languageDetected?: boolean;Property Value
boolean
Remarks
listTemplates
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 ListTemplateCollection object that represents all the list templates in the document.
listTemplates?: Word.Interfaces.ListTemplateData[];Property Value
Remarks
noLineBreakAfter
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 kinsoku characters after which Word will not break a line.
noLineBreakAfter?: string;Property Value
string
Remarks
noLineBreakBefore
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 kinsoku characters before which Word will not break a line.
noLineBreakBefore?: string;Property Value
string
Remarks
openEncoding
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.
Gets the encoding used to open the document.
openEncoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8";Property Value
Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"
Remarks
originalDocumentTitle
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.
Gets the title of the original document after legal-blackline comparison.
originalDocumentTitle?: string;Property Value
string
Remarks
pageSetup
Returns a PageSetup object that's associated with the document.
pageSetup?: Word.Interfaces.PageSetupData;Property Value
Remarks
password
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.
Sets a password that must be supplied to open the document.
password?: string;Property Value
string
Remarks
passwordEncryptionAlgorithm
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.
Gets the algorithm used for password encryption.
passwordEncryptionAlgorithm?: string;Property Value
string
Remarks
passwordEncryptionKeyLength
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.
Gets the key length used for password encryption.
passwordEncryptionKeyLength?: number;Property Value
number
Remarks
passwordEncryptionProvider
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.
Gets the name of the password encryption provider.
passwordEncryptionProvider?: string;Property Value
string
Remarks
path
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.
Gets the disk or the web path to the document (excludes the document name).
path?: string;Property Value
string
Remarks
printRevisions
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 revision marks are printed with the document.
printRevisions?: boolean;Property Value
boolean
Remarks
properties
Gets the properties of the document.
properties?: Word.Interfaces.DocumentPropertiesData;Property Value
Remarks
protectionType
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.
Gets the protection type for the document.
protectionType?: Word.ProtectionType | "NoProtection" | "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | "AllowOnlyReading";Property Value
Word.ProtectionType | "NoProtection" | "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | "AllowOnlyReading"
Remarks
readingLayoutSizeX
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 width of pages in reading layout view when frozen.
readingLayoutSizeX?: number;Property Value
number
Remarks
readingLayoutSizeY
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 height of pages in reading layout view when frozen.
readingLayoutSizeY?: number;Property Value
number
Remarks
readingModeIsLayoutFrozen
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 pages in reading layout view are frozen for handwritten markup.
readingModeIsLayoutFrozen?: boolean;Property Value
boolean
Remarks
removePersonalInformationOnSave
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 Word removes user information upon saving.
removePersonalInformationOnSave?: boolean;Property Value
boolean
Remarks
revisedDocumentTitle
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.
Gets the title of the revised document after legal-blackline comparison.
revisedDocumentTitle?: string;Property Value
string
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
Remarks
saveEncoding
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 encoding used when saving the document.
saveEncoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8";Property Value
Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"
Remarks
saveFormat
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.
Gets the file format of the document.
saveFormat?: Word.FileSaveFormat | "Document" | "Template" | "Text" | "TextLineBreaks" | "DosText" | "DosTextLineBreaks" | "Rtf" | "UnicodeText" | "Html" | "WebArchive" | "FilteredHtml" | "Xml" | "XmlDocument" | "XmlDocumentMacroEnabled" | "XmlTemplate" | "XmlTemplateMacroEnabled" | "DocumentDefault" | "Pdf" | "Xps" | "FlatXml" | "FlatXmlMacroEnabled" | "FlatXmlTemplate" | "FlatXmlTemplateMacroEnabled" | "OpenDocumentText" | "StrictOpenXmlDocument";Property Value
Word.FileSaveFormat | "Document" | "Template" | "Text" | "TextLineBreaks" | "DosText" | "DosTextLineBreaks" | "Rtf" | "UnicodeText" | "Html" | "WebArchive" | "FilteredHtml" | "Xml" | "XmlDocument" | "XmlDocumentMacroEnabled" | "XmlTemplate" | "XmlTemplateMacroEnabled" | "DocumentDefault" | "Pdf" | "Xps" | "FlatXml" | "FlatXmlMacroEnabled" | "FlatXmlTemplate" | "FlatXmlTemplateMacroEnabled" | "OpenDocumentText" | "StrictOpenXmlDocument"
Remarks
sections
Gets the collection of section objects in the document.
sections?: Word.Interfaces.SectionData[];Property Value
Remarks
selection
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 Selection object that represents the current selection in the document.
selection?: Word.Interfaces.SelectionData;Property Value
Remarks
settings
Gets the add-in's settings in the document.
settings?: Word.Interfaces.SettingData[];Property Value
Remarks
textEncoding
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 encoding for saving as encoded text.
textEncoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8";Property Value
Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"
Remarks
textLineEnding
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 how Word marks line and paragraph breaks in text files.
textLineEnding?: Word.LineEndingType | "Crlf" | "CrOnly" | "LfOnly" | "Lfcr" | "Lsps";Property Value
Word.LineEndingType | "Crlf" | "CrOnly" | "LfOnly" | "Lfcr" | "Lsps"
Remarks
trackedChangesAreDateAndTimeRemoved
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 to remove or store date and time metadata for tracked changes.
trackedChangesAreDateAndTimeRemoved?: boolean;Property Value
boolean
Remarks
trackFormatting
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 to track formatting changes when change tracking is on.
trackFormatting?: boolean;Property Value
boolean
Remarks
trackMoves
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 to mark moved text when Track Changes is on.
trackMoves?: boolean;Property Value
boolean
Remarks
trackRevisions
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 changes are tracked in the document.
trackRevisions?: boolean;Property Value
boolean
Remarks
type
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.
Gets the document type (template or document).
type?: Word.DocumentType | "Document" | "Template" | "Frameset";Property Value
Word.DocumentType | "Document" | "Template" | "Frameset"
Remarks
windows
Gets the collection of Word.Window objects for the document.
windows?: Word.Interfaces.WindowData[];Property Value
Remarks
writePassword
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.
Sets a password for saving changes to the document.
writePassword?: string;Property Value
string
Remarks
xmlAreAdvancedErrorsShown
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 error messages are generated from built-in Word messages or MSXML (Microsoft XML).
xmlAreAdvancedErrorsShown?: boolean;Property Value
boolean
Remarks
xmlIsXsltUsedWhenSaving
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 to save a document through an Extensible Stylesheet Language Transformation (XSLT).
xmlIsXsltUsedWhenSaving?: boolean;Property Value
boolean
Remarks
xmlSaveThroughXSLT
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 path and file name for the XSLT to apply when saving a document.
xmlSaveThroughXSLT?: string;Property Value
string