Edit

Share via


Word.Interfaces.DocumentUpdateData interface

An interface for updating data on the Document object, for use in document.set({ ... }).

Properties

activeWindow

Gets the active window for the document.

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.

autoHyphenation

Specifies if automatic hyphenation is turned on for the document.

autoSaveOn

Specifies if the edits in the document are automatically saved.

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.

changeTrackingMode

Specifies the ChangeTracking mode.

consecutiveHyphensLimit

Specifies the maximum number of consecutive lines that can end with hyphens.

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.

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.

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.

isKerningByAlgorithm

Specifies whether Word kerns half-width Latin characters and punctuation marks.

isLinguisticDataEmbedded

Specifies whether to embed speech and handwriting data.

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.

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.

isThemeLocked

Specifies whether users can change the document theme.

isUserControl

Specifies whether the document was created or opened by the user.

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.

pageSetup

Returns a PageSetup object that's associated with the document.

password

Sets a password that must be supplied to open the document.

printRevisions

Specifies whether revision marks are printed with the document.

properties

Gets the properties of 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.

saveEncoding

Specifies the encoding used when saving 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.

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

activeWindow

Gets the active window for the document.

activeWindow?: Word.Interfaces.WindowUpdateData;

Property Value

Remarks

[ API set: WordApiDesktop 1.2 ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

autoHyphenation

Specifies if automatic hyphenation is turned on for the document.

autoHyphenation?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

autoSaveOn

Specifies if the edits in the document are automatically saved.

autoSaveOn?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

bibliography

Returns a Bibliography object that represents the bibliography references contained within the document.

bibliography?: Word.Interfaces.BibliographyUpdateData;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

[ API set: WordApi 1.1 ]

changeTrackingMode

Specifies the ChangeTracking mode.

changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";

Property Value

Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"

Remarks

[ API set: WordApi 1.4 ]

consecutiveHyphensLimit

Specifies the maximum number of consecutive lines that can end with hyphens.

consecutiveHyphensLimit?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.3 ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

hyphenateCaps

Specifies whether words in all capital letters can be hyphenated.

hyphenateCaps?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

languageDetected

Specifies whether Microsoft Word has detected the language of the document text.

languageDetected?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

pageSetup

Returns a PageSetup object that's associated with the document.

pageSetup?: Word.Interfaces.PageSetupUpdateData;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

properties

Gets the properties of the document.

properties?: Word.Interfaces.DocumentPropertiesUpdateData;

Property Value

Remarks

[ API set: WordApi 1.3 ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]