Edit

Share via

Word JavaScript API desktop-only requirement set 1.4

The WordApiDesktop requirement set is a special requirement set that includes features that are only available for Word on Windows and on Mac. APIs in this requirement set are considered to be production APIs for the Word application on Windows and on Mac. They follow Microsoft 365 developer support policies. WordApiDesktop APIs are considered to be "preview" APIs for other platforms (for example, web) and may not be supported by any of those platforms.

When APIs in the WordApiDesktop requirement set are supported across all platforms, they'll be added to the next released requirement set (WordApi 1.[NEXT]). Once that new requirement set is public, those APIs will also continue to be tagged in this WordApiDesktop requirement set. To learn more about platform-specific requirements in general, see Understanding platform-specific requirement sets.

Important

WordApiDesktop 1.4 is a desktop-only requirement set. It's a superset of WordApiDesktop 1.3.

Because the WordApiDesktop 1.4 APIs are only supported by Word on Windows and on Mac, your add-in should check if the requirement set is supported before calling these APIs. This avoids any attempt to use desktop-only APIs on an unsupported platform.

if (Office.context.requirements.isSetSupported("WordApiDesktop", "1.4")) {
   // Any API exclusive to this WordApiDesktop requirement set.
}

Once the API is in a cross-platform requirement set, you should remove or edit the isSetSupported check. This will enable your add-in's feature on other platforms. Be sure to test the feature on those platforms when making this change.

Important

Your manifest cannot specify WordApiDesktop 1.4 as an activation requirement. It isn't a valid value to use in the Set element.

API list

The following table lists the Word JavaScript APIs currently included in the WordApiDesktop 1.4 requirement set. For a complete list of all Word JavaScript APIs (including WordApiDesktop 1.4 APIs and previously released APIs), see all Word JavaScript APIs.

Class Fields Description
Application fontNames Returns a FontNameCollection object that represents all the available font names in Microsoft Word.
listTemplateGalleries Returns a ListTemplateGalleryCollection object that represents all the list template galleries in Microsoft Word.
Bookmark copyTo(name: string) Copies this bookmark to the new bookmark specified in the name argument and returns a Bookmark object.
delete() Deletes the bookmark.
end Specifies the ending character position of the bookmark.
isColumn Returns true if the bookmark is a table column.
isEmpty Returns true if the bookmark is empty.
name Returns the name of the Bookmark object.
range Returns a Range object that represents the portion of the document that's contained in the Bookmark object.
select() Selects the bookmark.
start Specifies the starting character position of the bookmark.
storyType Returns the story type for the bookmark.
BookmarkCollection exists(name: string) Determines whether the specified bookmark exists.
items Gets the loaded child items in this collection.
Coauthor emailAddress Gets the email address of the coauthor.
id Gets the unique identifier for the Coauthor object.
isMe Gets whether this author represents the current user.
locks Gets a CoauthoringLockCollection object that represents the locks in the document that are associated with this coauthor.
name Gets the display name of the coauthor.
CoauthorCollection items Gets the loaded child items in this collection.
Coauthoring authors Gets a CoauthorCollection object that represents all the coauthors currently editing the document.
canCoauthor Gets whether this document can be coauthored.
canMerge Gets whether the document can be automatically merged.
conflicts Gets a ConflictCollection object that represents all the conflicts in the document.
locks Gets a CoauthoringLockCollection object that represents the locks in the document.
me Gets a Coauthor object that represents the current user.
pendingUpdates Gets whether the document has pending updates that have not been accepted.
updates Gets a CoauthoringUpdateCollection object that represents the most recent updates that were merged into the document.
CoauthoringLock owner Gets the owner of the lock.
range Gets a Range object that represents the portion of the document that's contained in the CoauthoringLock object.
type Gets a CoauthoringLockType value that represents the lock type.
unlock() Removes this lock, even if it belongs to a different user.
CoauthoringLockAddOptions range If provided, specifies the range to which the lock is added.
type If provided, specifies the type of lock.
CoauthoringLockCollection add(options?: Word.CoauthoringLockAddOptions) Returns a CoauthoringLock object that represents a lock added to a specified range.
items Gets the loaded child items in this collection.
unlockEphemeralLocks() Removes all ephemeral locks from the document.
CoauthoringUpdate range Gets a Range object that represents the portion of the document that's contained in the CoauthoringUpdate object.
CoauthoringUpdateCollection items Gets the loaded child items in this collection.
ConditionalStyle borders Returns a BorderUniversalCollection object that represents all the borders for the conditional style.
bottomPadding Specifies the amount of space (in points) to add below the contents of a single cell or all the cells in a table.
font Returns a Font object that represents the font formatting for the conditional style.
leftPadding Specifies the amount of space (in points) to add to the left of the contents of a single cell or all the cells in a table.
paragraphFormat Returns a ParagraphFormat object that represents the paragraph formatting for the conditional style.
rightPadding Specifies the amount of space (in points) to add to the right of the contents of a single cell or all the cells in a table.
shading Returns a ShadingUniversal object that represents the shading of the conditional style.
topPadding Specifies the amount of space (in points) to add above the contents of a single cell or all the cells in a table.
Conflict accept() Accepts the user's change and removes the conflict.
range Gets a Range object that represents the portion of the document that's contained in the Conflict object.
reject() Rejects the user's change, removes the conflict, and accepts the server copy of the change for the conflict.
type Gets the RevisionType for the Conflict object.
ConflictCollection acceptAll() Accepts all of the user's changes, removes the conflicts, and merges the changes into the server copy of the document.
items Gets the loaded child items in this collection.
rejectAll() Rejects all of the user's changes and retains the server copy of the document.
Document acceptAllRevisions() Accepts all tracked changes in the document.
acceptAllRevisionsShown() Accepts all revisions in the document that are displayed on the screen.
activate() Activates the document so that it becomes the active document.
activeTheme Gets the name of the active theme and formatting options.
activeThemeDisplayName Gets the display name of the active theme.
addToFavorites() Creates a shortcut to the document or hyperlink and adds it to the Favorites folder.
applyQuickStyleSet(style: Word.ApplyQuickStyleSet) Applies the specified Quick Style set to the document.
applyTheme(name: string) Applies the specified theme to this document.
areFilePropertiesPasswordEncrypted Gets whether Word encrypts file properties for password-protected documents.
areGrammaticalErrorsShown Specifies whether grammatical errors are marked by a wavy green line in the document.
areMathDefaultsUsed Specifies whether to use the default math settings when creating new equations.
areNewerFeaturesDisabled Specifies whether to disable features introduced after a specified version.
areSpellingErrorsShown Specifies whether Microsoft Word underlines spelling errors in the document.
areStylesUpdatedOnOpen Specifies whether the styles in this document are updated to match the styles in the attached template each time the document is opened.
areTrueTypeFontsEmbedded Specifies whether Microsoft Word embeds TrueType fonts in the document when it's saved.
autoFormat() Automatically formats the document.
background Gets a Shape object that represents the background image for the document.
bookmarks Returns a BookmarkCollection object that represents all the bookmarks in the document.
builtInDocumentProperties Gets a DocumentProperties object that represents all the built-in document properties for the document.
canCheckin() Returns true if Microsoft Word can check in the document to a server.
characters Gets the RangeScopedCollection object that represents all the characters in the document.
checkConsistencyJapanese() Searches all text in a Japanese language document and displays instances where character usage is inconsistent for the same words.
checkGrammar() Begins a spelling and grammar check for the document.
closePrintPreview() Switches the document from print preview to the previous view.
coauthoring Gets a Coauthoring object for managing coauthoring in the document.
codeName Gets the code name for the document.
comments Gets a CommentCollection object that represents all the comments in the document.
compatibilityMode Gets the compatibility mode that Word uses when opening the document.
content Gets a Range object that represents the main document story.
convert() Converts the file to the newest format and enables all features.
convertAutoHyphens() Converts automatic hyphens to manual hyphens.
convertNumbersToText(numberType?: Word.NumberType) Changes the list numbers and LISTNUM fields in the document to text.
convertVietnameseDocument(codePageOrigin: number) Reconverts a Vietnamese document to Unicode using a code page other than the default.
copyStylesFromTemplate(StyleTemplate: string) Copies styles from the specified template to the document.
currentRsid Gets a random number that Word assigns to changes in the document.
customDocumentProperties Gets a DocumentProperties collection that represents all the custom document properties for the document.
defaultTabStop Specifies the interval (in points) between the default tab stops in the document.
defaultTargetFrame Specifies the browser frame for displaying a webpage via hyperlink.
deleteAllComments() Deletes all comments from the document.
deleteAllCommentsShown() Deletes all revisions in the document that are displayed on the screen.
deleteAllInkAnnotations() Deletes all handwritten ink annotations in the document.
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.
fields Gets a FieldCollection object that represents all the fields in the document.
fitToPages() Decreases the font size of text just enough so that the document page count drops by one.
formattingIsNextLevelShown Specifies whether Word shows the next heading level when the previous is used.
formattingIsUserStyleNameShown Specifies whether to show user-defined styles.
freezeLayout() Fixes the layout of the document in Web view.
fullName Gets the name of a document, including the path.
getCrossReferenceItems(referenceType: Word.ReferenceType) Returns an array of items that can be cross-referenced based on the specified cross-reference type.
grammaticalErrors Gets a RangeCollection object that represents the sentences that failed the grammar check in the document.
gridDistanceHorizontal Specifies the horizontal space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document.
gridDistanceVertical Specifies the vertical space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document.
gridIsOriginFromMargin Specifies whether the character grid starts from the upper-left corner of the page.
gridOriginHorizontal Specifies the horizontal origin point for the invisible grid.
gridOriginVertical Specifies the vertical origin point for the invisible grid.
gridSpaceBetweenHorizontalLines Specifies the interval for horizontal character gridlines in print layout view.
gridSpaceBetweenVerticalLines Specifies the interval for vertical character gridlines in print layout view.
hasPassword Gets whether a password is required to open the document.
hasVbProject Gets whether the document has an attached Microsoft Visual Basic for Applications project.
hyphenationZone Specifies the width of the hyphenation zone, in points.
indexes Returns an IndexCollection object that represents all the indexes in the document.
isAutoFormatOverrideOn Specifies whether automatic formatting options override formatting restrictions.
isChartDataPointTracked Specifies whether charts in the active document use cell-reference data-point tracking.
isCompatible Specifies whether the compatibility option specified by the type property is enabled.
isFinal Specifies whether the document is final.
isFontsSubsetSaved Specifies whether Microsoft Word saves a subset of the embedded TrueType fonts with the document.
isFormsDataPrinted Specifies whether Microsoft Word prints onto a preprinted form only the data entered in the corresponding online form.
isFormsDataSaved Specifies whether Microsoft Word saves the data entered in a form as a tab-delimited record for use in a database.
isGrammarChecked Specifies whether a grammar check has been run on the document.
isInAutoSave Gets whether the most recent firing of the Application.DocumentBeforeSave event was the result of an automatic save by the document or a manual save by the user.
isInFormsDesign Gets whether the document is in form design mode.
isKerningByAlgorithm Specifies whether Word kerns half-width Latin characters and punctuation marks.
isLinguisticDataEmbedded Specifies whether to embed speech and handwriting data.
isMasterDocument Gets whether this document is a master document.
isOptimizedForWord97 Specifies whether Word optimizes the document for Word 97.
isPostScriptPrintedOverText Specifies whether PRINT field instructions (such as PostScript commands) in the document are to be printed on top of text and graphics when a PostScript printer is used.
isQuickStyleSetLocked Specifies whether users can change the Quick Style set.
isReadOnly Gets whether changes to the document cannot be saved to the original document.
isReadOnlyRecommended Specifies whether Microsoft Word displays a message box whenever a user opens the document, suggesting that it be opened as read-only.
isSnappedToGrid Specifies whether AutoShapes or East Asian characters are automatically aligned with an invisible grid.
isSnappedToShapes Specifies whether AutoShapes or East Asian characters align with invisible gridlines through other shapes.
isSpellingChecked Specifies whether spelling has been checked throughout the document.
isStyleEnforced Specifies whether formatting restrictions are enforced in a protected document.
isSubdocument Gets whether this document is a subdocument of a master document.
isThemeLocked Specifies whether users can change the document theme.
isUserControl Specifies whether the document was created or opened by the user.
isVbaSigned Gets whether the VBA project is digitally signed.
isWriteReserved Gets whether the document is protected with a write password.
justificationMode Specifies the character spacing adjustment.
kind Specifies the format type that Microsoft Word uses when automatically formatting the document.
listParagraphs Gets a ParagraphCollection object that represents all the numbered paragraphs in the document.
listTemplates Returns a ListTemplateCollection object that represents all the list templates in the document.
lists Gets a ListCollection object that contains all the formatted lists in the document.
lockServerFile() Locks the file on the server preventing anyone else from editing it.
makeCompatibilityDefault() Sets the compatibility options.
noLineBreakAfter Specifies the kinsoku characters after which Word will not break a line.
noLineBreakBefore Specifies the kinsoku characters before which Word will not break a line.
openEncoding Gets the encoding used to open the document.
originalDocumentTitle Gets the title of the original document after legal-blackline comparison.
paragraphs Gets a ParagraphCollection object that represents all the paragraphs in the document.
password Sets a password that must be supplied to open the document.
passwordEncryptionAlgorithm Gets the algorithm used for password encryption.
passwordEncryptionKeyLength Gets the key length used for password encryption.
passwordEncryptionProvider Gets the name of the password encryption provider.
path Gets the disk or the web path to the document (excludes the document name).
post() Posts the document to a public folder in Microsoft Exchange.
presentIt() Opens PowerPoint with the Word document loaded.
printPreview() Switches the view to print preview.
printRevisions Specifies whether revision marks are printed with the document.
protectionType Gets the protection type for the document.
readabilityStatistics Gets a ReadabilityStatisticCollection object that represents the readability statistics for the document.
readingLayoutSizeX Specifies the width of pages in reading layout view when frozen.
readingLayoutSizeY Specifies the height of pages in reading layout view when frozen.
readingModeIsLayoutFrozen Specifies whether pages in reading layout view are frozen for handwritten markup.
redo(times?: number) Redoes the last action that was undone (reverses the undo method).
rejectAllRevisions() Rejects all tracked changes in the document.
rejectAllRevisionsShown() Rejects all revisions in the document that are displayed on the screen.
reload() Reloads a cached document by resolving the hyperlink to the document and downloading it.
reloadAs(encoding: Word.DocumentEncoding) Reloads the document based on an HTML document, using the document encoding.
removeDocumentInformation(removeDocInfoType: Word.RemoveDocInfoType) Removes sensitive information, properties, comments, and other metadata from the document.
removeLockedStyles() Purges the document of locked styles when formatting restrictions have been applied in the document.
removeNumbers(numberType?: Word.NumberType) Removes numbers or bullets from the document.
removePersonalInformationOnSave Specifies whether Word removes user information upon saving.
removeTheme() Removes the active theme from the current document.
repaginate() Repaginates the entire document.
resetFormFields() Clears all form fields in the document, preparing the form to be filled in again.
returnToLastReadPosition() Returns the document to the last saved reading position.
revisedDocumentTitle Gets the title of the revised document after legal-blackline comparison.
revisions Gets the collection of revisions that represents the tracked changes in the document.
runAutoMacro(autoMacro: Word.AutoMacro) Runs an auto macro that's stored in the document.
saveAsQuickStyleSet(fileName: string) Saves the group of quick styles currently in use.
saveEncoding Specifies the encoding used when saving the document.
saveFormat Gets the file format of the document.
select() Selects the contents of the document.
selectContentControlsByTag(tag: string) Returns all content controls with the specified tag.
selectContentControlsByTitle(title: string) Returns a ContentControlCollection object that represents all the content controls in the document with the specified title.
selectLinkedControls(node: Word.CustomXmlNode) Returns a ContentControlCollection object that represents all content controls in the document that are linked to the specific custom XML node.
selectNodes(xPath: string, options?: Word.SelectNodesOptions) Returns an XmlNodeCollection object that represents all the nodes that match the XPath parameter in the order in which they appear in the document.
selectSingleNode(xPath: string, options?: Word.SelectSingleNodeOptions) Returns an XmlNode object that represents the first node that matches the XPath parameter in the document.
selectUnlinkedControls(stream?: Word.CustomXmlPart) Returns a ContentControlCollection object that represents all content controls in the document that are not linked to an XML node.
selection Returns a Selection object that represents the current selection in the document.
sendFax(address: string, subject?: string) Sends the document as a fax, without any user interaction.
sendMail() Opens a message window for sending the document through Microsoft Exchange.
sentences Gets the RangeScopedCollection object that represents all the sentences in the document.
setDefaultTableStyle(style: string, setInTemplate: boolean) Specifies the table style to use for newly created tables in the document.
setPasswordEncryptionOptions(passwordEncryptionProvider: string, passwordEncryptionAlgorithm: string, passwordEncryptionKeyLength: number, passwordEncryptFileProperties?: boolean) Sets the options Microsoft Word uses for encrypting documents with passwords.
spellingErrors Gets a RangeCollection object that represents the words identified as spelling errors in the document.
storyRanges Gets a RangeCollection object that represents all the stories in the document.
styles Gets a StyleCollection for the document.
tableOfAuthoritiesCategories Returns a TableOfAuthoritiesCategoryCollection object that represents the available table of authorities categories in the document.
tables Gets a TableCollection object that represents all the tables in the document.
tablesOfAuthorities Returns a TableOfAuthoritiesCollection object that represents all the tables of authorities in the document.
tablesOfContents Returns a TableOfContentsCollection object that represents all the tables of contents in the document.
tablesOfFigures Returns a TableOfFiguresCollection object that represents all the tables of figures in the document.
textEncoding Specifies the encoding for saving as encoded text.
textLineEnding Specifies how Word marks line and paragraph breaks in text files.
toggleFormsDesign() Switches form design mode on or off.
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.
trackedChangesAreDateAndTimeRemoved Specifies whether to remove or store date and time metadata for tracked changes.
transformDocument(path: string, dataOnly?: boolean) Applies the specified Extensible Stylesheet Language Transformation (XSLT) file to this document and replaces the document with the results.
type Gets the document type (template or document).
undo(times?: number) Undoes the last action or a sequence of actions, which are displayed in the Undo list.
undoClear() Clears the list of actions that can be undone in the document.
unprotect(password?: string) Removes protection from the document.
updateStyles() Copies all styles from the attached template into the document, overwriting any existing styles in the document that have the same name.
viewCode() Displays the code window for the selected Microsoft ActiveX control in the document.
viewPropertyBrowser() Displays the property window for the selected Microsoft ActiveX control in the document.
webPagePreview() Displays a preview of the current document as it would look if saved as a webpage.
webSettings Gets the WebSettings object for webpage-related attributes.
words Gets the RangeScopedCollection object that represents each word 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.
DropCap clear() Removes the dropped capital letter formatting.
distanceFromText Gets the distance (in points) between the dropped capital letter and the paragraph text.
enable() Formats the first character in the specified paragraph as a dropped capital letter.
fontName Gets the name of the font for the dropped capital letter.
linesToDrop Gets the height (in lines) of the dropped capital letter.
position Gets the position of the dropped capital letter.
Editor delete() Deletes the Editor object.
id Gets the identifier for the Editor object when the parent document is saved as a webpage.
name Gets the name of the editor.
nextRange Gets a Range object that represents the next range that the editor has permissions to modify.
range Gets a Range object that represents the portion of the document that's contained in the Editor object.
removeAllPermissions() Removes all editing permissions in the document for the editor.
selectAllShapes() Selects all the shapes in the document that were inserted or edited by the editor.
EditorCollection addById(editorId: string) Returns an Editor object that represents a new permission for the specified user to modify a range within the document.
addByType(editorType: Word.EditorType) Returns an Editor object that represents a new permission for the specified group of users to modify a range within the document.
getCount() Returns the number of items in the collection.
getItemAt(index: number) Gets an Editor object by its index in the collection.
Field copyToClipboard() Copies the field to the Clipboard.
cut() Removes the field from the document and places it on the Clipboard.
doClick() Clicks the field.
linkFormat Gets a LinkFormat object that represents the link options of the field.
oleFormat Gets an OleFormat object that represents the OLE characteristics (other than linking) for the field.
unlink() Replaces the field with its most recent result.
updateSource() Saves the changes made to the results of an INCLUDETEXT field back to the source document.
FontNameCollection getCount() Returns the number of items in the collection.
getItemAt(index: number) Gets the font name at the specified index.
HeadingStyle delete() Deletes the heading style.
level Specifies the level for the heading style in a table of contents or table of figures.
name Specifies the name of style for a heading.
HeadingStyleCollection add(name: string, level: number) Adds a new heading style to a document.
items Gets the loaded child items in this collection.
HtmlDivision delete() Deletes this HTML division.
htmlDivisionParent(levelsUp?: number) Returns an HtmlDivision object that represents a parent division of the current HTML division.
htmlDivisions
leftIndent Specifies the left indent value (in points) for this HTML division.
range Gets a Range object that represents the portion of a document that's contained in this HTML division.
rightIndent Specifies the right indent (in points) for this HTML division.
spaceAfter Specifies the amount of spacing (in points) after this HTML division.
spaceBefore Specifies the spacing (in points) before this HTML division.
HtmlDivisionCollection getItemAt(index: number) Returns an HtmlDivision object from the collection based on the specified index.
items Gets the loaded child items in this collection.
Index delete() Deletes this index.
filter Gets a value that represents how Microsoft Word classifies the first character of entries in the index.
headingSeparator Gets the text between alphabetical groups (entries that start with the same letter) in the index.
indexLanguage Gets a LanguageId value that represents the sorting language to use for the index.
numberOfColumns Gets the number of columns for each page of the index.
range Returns a Range object that represents the portion of the document that is contained within the index.
rightAlignPageNumbers Specifies if page numbers are aligned with the right margin in the index.
separateAccentedLetterHeadings Gets if the index contains separate headings for accented letters (for example, words that begin with "À" are under
sortBy Specifies the sorting criteria for the index.
tabLeader Specifies the leader character between entries in the index and their associated page numbers.
type Gets the index type.
IndexAddOptions headingSeparator If provided, specifies the text between alphabetical groups (entries that start with the same letter) in the index.
indexLanguage If provided, specifies the sorting language to be used for the index being added.
numberOfColumns If provided, specifies the number of columns for each page of the index.
rightAlignPageNumbers If provided, specifies whether the page numbers in the generated index are aligned with the right margin.
separateAccentedLetterHeadings If provided, specifies whether to include separate headings for accented letters in the index.
sortBy If provided, specifies the sorting criteria to be used for the index being added.
type If provided, specifies whether subentries are on the same line (run-in) as the main entry or on a separate line (indented) from the main entry.
IndexCollection add(range: Word.Range, indexAddOptions?: Word.IndexAddOptions) Returns an Index object that represents a new index added to the document.
getFormat() Gets the IndexFormat value that represents the formatting for the indexes in the document.
items Gets the loaded child items in this collection.
markAllEntries(range: Word.Range, markAllEntriesOptions?: Word.IndexMarkAllEntriesOptions) Inserts an XE (Index Entry) field after all instances of the text in the range.
IndexMarkAllEntriesOptions bold If provided, specifies whether to add bold formatting to page numbers for index entries.
bookmarkName If provided, specifies the bookmark name that marks the range of pages you want to appear in the index.
crossReference If provided, specifies the cross-reference that will appear in the index.
crossReferenceAutoText If provided, specifies the name of the AutoText entry that contains the text for a cross-reference (if this property is specified, crossReference is ignored).
entry If provided, specifies the text you want to appear in the index, in the form MainEntry[:Subentry].
entryAutoText If provided, specifies the AutoText entry that contains the text you want to appear in the index (if this property is specified, entry is ignored).
italic If provided, specifies whether to add italic formatting to page numbers for index entries.
LinkFormat breakLink() Breaks the link between the source file and the OLE object, picture, or linked field.
isAutoUpdated Specifies if the link is updated automatically when the container file is opened or when the source file is changed.
isLocked Specifies if a Field, InlineShape, or Shape object is locked to prevent automatic updating.
isPictureSavedWithDocument Specifies if the linked picture is saved with the document.
sourceFullName Specifies the path and name of the source file for the linked OLE object, picture, or field.
sourceName Gets the name of the source file for the linked OLE object, picture, or field.
sourcePath Gets the path of the source file for the linked OLE object, picture, or field.
type Gets the link type.
ListTemplate name Specifies the name of the list template.
ListTemplateCollection items Gets the loaded child items in this collection.
ListTemplateGallery listTemplates Returns a ListTemplateCollection object that represents all the list templates for the specified list gallery.
ListTemplateGalleryCollection getByType(type: Word.ListTemplateGalleryType) Gets a ListTemplateGallery object by its type in the collection.
items Gets the loaded child items in this collection.
OleFormat activate() Activates the OleFormat object.
activateAs(classType: string) Sets the Windows registry value that determines the default application used to activate the specified OLE object.
classType Specifies the class type for the specified OLE object, picture, or field.
doVerb(verbIndex: Word.OleVerb) Requests that the OLE object perform one of its available verbs.
edit() Opens the OLE object for editing in the application it was created in.
iconIndex Specifies the icon that is used when the displayAsIcon property is true.
iconLabel Specifies the text displayed below the icon for the OLE object.
iconName Specifies the program file in which the icon for the OLE object is stored.
iconPath Gets the path of the file in which the icon for the OLE object is stored.
isDisplayedAsIcon Gets whether the specified object is displayed as an icon.
isFormattingPreservedOnUpdate Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved.
label Gets a string that's used to identify the portion of the source file that's being linked.
open() Opens the OleFormat object.
progId Gets the programmatic identifier (ProgId) for the specified OLE object.
Pane selection Returns a Selection object that represents the current selection in the pane.
Paragraph closeUp() Removes any spacing before the paragraph.
indent() Indents the paragraph by one level.
indentCharacterWidth(count: number) Indents the paragraph by a specified number of characters.
indentFirstLineCharacterWidth(count: number) Indents the first line of the paragraph by the specified number of characters.
joinList() Joins a list paragraph with the closest list above or below this paragraph.
next(count: number) Returns a Paragraph object that represents the next paragraph.
openOrCloseUp() Toggles the spacing before the paragraph.
openUp() Sets spacing before the paragraph to 12 points.
outdent() Removes one level of indent for the paragraph.
outlineDemote() Applies the next heading level style (Heading 1 through Heading 8) to the paragraph.
outlineDemoteToBody() Demotes the paragraph to body text by applying the Normal style.
outlinePromote() Applies the previous heading level style (Heading 1 through Heading 8) to the paragraph.
previous(count: number) Returns the previous paragraph as a Paragraph object.
reset() Removes manual paragraph formatting (formatting not applied using a style).
resetAdvanceTo() Resets the paragraph that uses custom list levels to the original level settings.
selectNumber() Selects the number or bullet in a list.
separateList() Separates a list into two separate lists.
space1() Sets the paragraph to single spacing.
space1Pt5() Sets the paragraph to 1.5-line spacing.
space2() Sets the paragraph to double spacing.
tabHangingIndent(count: number) Sets a hanging indent to a specified number of tab stops.
tabIndent(count: number) Sets the left indent for the paragraph to a specified number of tab stops.
ParagraphCollection add(range: Word.Range) Returns a Paragraph object that represents a new, blank paragraph added to the document.
closeUp() Removes any spacing before the specified paragraphs.
decreaseSpacing() Decreases the spacing before and after paragraphs in six-point increments.
increaseSpacing() Increases the spacing before and after paragraphs in six-point increments.
indent() Indents the paragraphs by one level.
indentCharacterWidth(count: number) Indents the paragraphs in the collection by the specified number of characters.
indentFirstLineCharacterWidth(count: number) Indents the first line of the paragraphs in the collection by the specified number of characters.
openOrCloseUp() Toggles spacing before paragraphs.
openUp() Sets spacing before the specified paragraphs to 12 points.
outdent() Removes one level of indent for the paragraphs.
outlineDemote() Applies the next heading level style (Heading 1 through Heading 8) to the specified paragraphs.
outlineDemoteToBody() Demotes the specified paragraphs to body text by applying the Normal style.
outlinePromote() Applies the previous heading level style (Heading 1 through Heading 8) to the paragraphs in the collection.
space1() Sets the specified paragraphs to single spacing.
space1Pt5() Sets the specified paragraphs to 1.5-line spacing.
space2() Sets the specified paragraphs to double spacing.
tabHangingIndent(count: number) Sets a hanging indent to the specified number of tab stops.
tabIndent(count: number) Sets the left indent for the specified paragraphs to the specified number of tab stops.
Range bold Specifies whether the range is formatted as bold.
boldBidirectional Specifies whether the range is formatted as bold in a right-to-left language document.
bookmarks Returns a BookmarkCollection object that represents all the bookmarks in the range.
borders Returns a BorderUniversalCollection object that represents all the borders for the range.
case Specifies a CharacterCase value that represents the case of the text in the range.
characterWidth Specifies the character width of the range.
combineCharacters Specifies if the range contains combined characters.
conflicts Returns a ConflictCollection object that contains all the Word.Conflict objects in the range.
disableCharacterSpaceGrid Specifies if Microsoft Word ignores the number of characters per line for the corresponding Range object.
editors Returns an EditorCollection object that represents all the users authorized to modify the range when the document is in protected (read-only) mode.
emphasisMark Specifies the emphasis mark for a character or designated character string.
end Specifies the ending character position of the range.
fitTextWidth Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range.
grammarChecked Specifies if a grammar check has been run on the range or document.
highlightColorIndex Specifies the highlight color for the range.
horizontalInVertical Specifies the formatting for horizontal text set within vertical text.
id Specifies the ID for the range.
isEndOfRowMark Gets if the range is collapsed and is located at the end-of-row mark in a table.
isTextVisibleOnScreen Gets whether the text in the range is visible on the screen.
italic Specifies if the font or range is formatted as italic.
italicBidirectional Specifies if the font or range is formatted as italic (right-to-left languages).
kana Specifies whether the range of Japanese language text is hiragana or katakana.
revisions Gets the collection of revisions that represents the tracked changes in the range.
showAll Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed.
spellingChecked Specifies if spelling has been checked throughout the range or document.
start Specifies the starting character position of the range.
storyLength Gets the number of characters in the story that contains the range.
storyType Gets the story type for the range.
twoLinesInOne Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any.
RangeScopedCollection items Gets the loaded child items in this collection.
ReadabilityStatistic name Returns the name of the readability statistic.
value Returns the value of the grammar statistic.
ReadabilityStatisticCollection getItemAt(index: number) Gets the readability statistic at the specified index.
items Gets the loaded child items in this collection.
Reviewer isVisible Specifies if the Reviewer object is visible.
ReviewerCollection items Gets the loaded child items in this collection.
Revision accept() Accepts the tracked change, removes the revision mark, and incorporates the change into the document.
author Gets the name of the user who made the tracked change.
date Gets the date and time when the tracked change was made.
formatDescription Gets the description of tracked formatting changes in the revision.
index Gets a number that represents the position of this item in a collection.
movedRange Gets a Range object that represents the range of text that was moved from one place to another in the document with tracked changes.
range Gets a Range object that represents the portion of the document that's contained within a revision mark.
reject() Rejects the tracked change.
type Gets the revision type.
RevisionCollection acceptAll() Accepts all the tracked changes in the document or range, removes all revision marks, and incorporates the changes into the document.
items Gets the loaded child items in this collection.
rejectAll() Rejects all the tracked changes in the document or range.
RevisionsFilter markup Specifies a RevisionsMarkup value that represents the extent of reviewer markup displayed in the document.
reviewers Gets the ReviewerCollection object that represents the collection of reviewers of one or more documents.
toggleShowAllReviewers() Shows or hides all revisions in the document that contain comments and tracked changes.
view Specifies a RevisionsView value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied.
SelectNodesOptions fastSearchSkippingTextNodes If provided, specifies whether to skip text nodes in the search.
prefixMapping If provided, specifies the prefix mapping for the XPath expression.
SelectSingleNodeOptions fastSearchSkippingTextNodes If provided, specifies whether to skip text nodes in the search.
prefixMapping If provided, specifies the prefix mapping for the XPath expression.
Selection borders Returns a BorderUniversalCollection object that represents all the borders for the objects in the selection.
calculate() Calculates the first mathematical expression within the selection.
cancelMode() Cancels a mode such as extend or column select.
characters Returns a RangeScopedCollection object that represents each character in the selection.
clearCharacterStyleFormatting() Removes character formatting applied through character styles.
clearFormatting() Removes character and paragraph formatting from the selection.
clearManualCharacterFormatting() Removes manually applied character formatting from the selected text.
clearManualParagraphFormatting() Removes manually applied paragraph formatting from the selected text.
clearParagraphFormatting() Removes all paragraph formatting from the selected text.
clearParagraphStyle() Removes paragraph formatting applied through paragraph styles.
collapse(direction?: Word.CollapseDirection) Collapses the selection to the starting or ending position.
comments Returns a CommentCollection object that represents all the comments in the selection.
copyAsPictureToClipboard() Copies the selection to the Clipboard as a picture.
copyFormat() Copies the character formatting of the first character in the selected text.
copyToClipboard() Copies the selection to the Clipboard.
createTextBox() Adds a default-sized text box around the selection.
cut() Removes the selected content from the document and moves it to the Clipboard.
delete(options?: Word.SelectionDeleteOptions) Deletes the specified number of characters or words.
detectLanguage() Analyzes the selected text to determine the language that it's written in.
end Specifies the ending character position of the selection.
expand(unit?: Word.OperationUnit) Expands the selection.
expandToWholeStory() Expands the selection to include the entire story.
extend(character?: Word.OperationUnit) Turns on extend mode, or if extend mode is already on, extends the selection to the next larger unit of text.
fields Returns a FieldCollection object that represents all the fields in the selection.
fitTextWidth Specifies the width in which Word fits the text in the current selection.
font Returns the Font object that represents the character formatting of the selection.
formattedText Specifies a Range object that includes the formatted text in the range or selection.
getNextRange(options?: Word.SelectionNextOptions) Returns a Range object that represents the next unit relative to the selection.
getPreviousRange(options?: Word.SelectionPreviousOptions) Returns a Range object that represents the previous unit relative to the selection.
goToNext(what: Word.GoToItem) Returns a Range object that refers to the start position of the next item or location specified by the what argument and moves the selection to the specified item.
goToPrevious(what: Word.GoToItem) Returns a Range object that refers to the start position of the previous item or location specified by the what argument and moves the selection to the specified item.
hasNoProofing Returns whether the spelling and grammar checker ignores the selected text.
insertAfter(text: string) Inserts the specified text at the end of the range or selection.
insertBefore(text: string) Inserts the specified text before the selection.
insertCells(shiftCells?: Word.TableCellInsertionLocation) Adds cells to an existing table.
insertColumnsLeft() Inserts columns to the left of the column that contains the selection.
insertColumnsRight() Inserts columns to the right of the current selection.
insertDateTime(options?: Word.SelectionInsertDateTimeOptions) Inserts the current date or time, or both, either as text or as a TIME field.
insertFormula(options?: Word.SelectionInsertFormulaOptions) Inserts a Formula field at the selection.
insertNewPage() Inserts a new page at the position of the insertion point.
insertParagraphAfter() Inserts a paragraph mark after the selection.
insertParagraphBefore() Inserts a new paragraph before the selection or range.
insertParagraphStyleSeparator() Inserts a special hidden paragraph mark that allows Word to join paragraphs formatted using different paragraph styles.
insertRowsAbove(numRows: number) Inserts rows above the current selection.
insertRowsBelow(numRows: number) Inserts rows below the current selection.
insertSymbol(characterNumber: number, options?: Word.SelectionInsertSymbolOptions) Inserts a symbol in place of the specified selection.
insertText(Text: string) Inserts the specified text.
insertXml(xml: string, transform?: string) Inserts the specified XML into the document at the cursor, replacing any selected text.
isActive Returns whether the selection in the specified window or pane is active.
isColumnSelectModeActive Specifies whether column selection mode is active.
isEndOfRowMark Returns whether the selection is at the end-of-row mark in a table.
isEqual(range: Word.Range) Returns whether the selection is equal to the specified range.
isExtendModeActive Specifies whether Extend mode is active.
isInRange(range: Word.Range) Returns true if the selection is contained within the specified range.
isInStory(range: Word.Range) Returns whether the selection is in the same story as the specified range.
isInsertionPointAtEndOfLine Returns whether the insertion point is at the end of a line.
isStartActive Specifies whether the beginning of the selection is active.
languageDetected Specifies whether Word has detected the language of the selected text.
languageId Returns the language for the selection.
languageIdFarEast Returns the East Asian language for the selection.
languageIdOther Returns the language for the selection that isn't classified as an East Asian language.
move(options?: Word.SelectionMoveOptions) Collapses the selection to its start or end position and then moves the collapsed object by the specified number of units.
moveDown(options?: Word.SelectionMoveUpDownOptions) Moves the selection down.
moveEnd(options?: Word.SelectionMoveStartEndOptions) Moves the ending character position of the range or selection.
moveEndUntil(characters: string, count?: number) Moves the end position of the selection until any of the specified characters are found in the document.
moveEndWhile(characters: string, count?: number) Moves the ending character position of the selection while any of the specified characters are found in the document.
moveLeft(options?: Word.SelectionMoveLeftRightOptions) Moves the selection to the left.
moveRight(options?: Word.SelectionMoveLeftRightOptions) Moves the selection to the right.
moveStart(options?: Word.SelectionMoveStartEndOptions) Moves the start position of the selection.
moveStartUntil(characters: string, count?: number) Moves the start position of the selection until one of the specified characters is found in the document.
moveStartWhile(characters: string, count?: number) Moves the start position of the selection while any of the specified characters are found in the document.
moveUntil(characters: string, count?: number) Moves the selection until one of the specified characters is found in the document.
moveUp(options?: Word.SelectionMoveUpDownOptions) Moves the selection up.
moveWhile(characters: string, count?: number) Moves the selection while any of the specified characters are found in the document.
nextField() Selects the next field.
nextSubdocument() Moves the selection to the next subdocument.
orientation Specifies the orientation of text in the selection.
paragraphs Returns a ParagraphCollection object that represents all the paragraphs in the selection.
pasteAndFormat(type: Word.PasteFormatType) Pastes the content from clipboard and formats them as specified.
pasteExcelTable(linkedToExcel: boolean, wordFormatting: boolean, rtf: boolean) Pastes and formats a Microsoft Excel table.
pasteFormat() Applies formatting copied with the copyFormat method to the selection.
pasteTableCellsAppendTable() Merges pasted cells into an existing table by inserting the pasted rows between the selected rows.
pasteTableCellsAsNestedTable() Pastes a cell or group of cells as a nested table into the selection.
previousField() Selects and returns the previous field.
previousSubdocument() Moves the selection to the previous subdocument.
range Returns the Range object for the portion of the document contained in the selection.
replaceParagraph() Replaces the selection with a new paragraph.
sections Returns the SectionCollection object in the selection.
select() Selects the current text.
selectCell() Selects the entire cell containing the current selection when the selection is in a table.
selectColumn() Selects the column that contains the insertion point, or selects all columns that contain the selection when the selection is in a table.
selectCurrentAlignment() Extends the selection forward until text with a different paragraph alignment is encountered.
selectCurrentColor() Extends the selection forward until text with a different color is encountered.
selectCurrentFont() Extends the selection forward until text in a different font or font size is encountered.
selectCurrentIndent() Extends the selection forward until text with different left or right paragraph indents is encountered.
selectCurrentSpacing() Extends the selection forward until a paragraph with different line spacing is encountered.
selectCurrentTabs() Extends the selection forward until a paragraph with different tab stops is encountered.
selectRow() Selects the row that contains the insertion point, or selects all rows that contain the selection when the selection is in a table.
sentences Returns the RangeScopedCollection object for each sentence in the selection.
setRange(start: number, end: number) Sets the starting and ending character positions for the selection.
shading Returns the ShadingUniversal object for the shading formatting for the selection.
shrink() Shrinks the selection to the next smaller unit of text.
shrinkDiscontiguousSelection() Cancels the selection of all but the most recently selected text when the current selection contains multiple, unconnected selections.
splitTable() Inserts an empty paragraph above the first row in the selection.
start Specifies the starting character position of the selection.
storyLength Returns the number of characters in the story that contains the selection.
storyType Returns the story type for the selection.
tables Returns the TableCollection object in the selection.
text Specifies the text in the selection.
toggleCharacterCode() Switches the selection between a Unicode character and its corresponding hexadecimal value.
topLevelTables Returns the tables at the outermost nesting level in the current selection.
type Returns the selection type.
typeBackspace() Deletes the character preceding the selection (if collapsed) or the insertion point.
words Returns the RangeScopedCollection object that represents each word in the selection.
SelectionDeleteOptions count If provided, specifies the number of units to be deleted.
unit If provided, specifies the unit by which the collapsed selection is to be deleted.
SelectionInsertDateTimeOptions calendarType If provided, specifies the calendar type to use when displaying the date or time.
dateLanguage If provided, specifies the language in which to display the date or time.
dateTimeFormat If provided, specifies the format to be used for displaying the date or time, or both.
insertAsField If provided, specifies whether to insert the specified information as a TIME field.
insertAsFullWidth If provided, specifies whether to insert the specified information as full-width (double-byte) digits.
SelectionInsertFormulaOptions formula If provided, specifies the mathematical formula you want the = (Formula) field to evaluate.
numberFormat If provided, specifies the format for the result of the = (Formula) field.
SelectionInsertSymbolOptions bias If provided, specifies the font bias for symbols.
font If provided, specifies the name of the font that contains the symbol.
unicode If provided, specifies whether the character is Unicode.
SelectionMoveLeftRightOptions count If provided, specifies the number of units the selection is to be moved.
extend If provided, specifies the type of movement.
unit If provided, specifies the unit by which the selection is to be moved.
SelectionMoveOptions count If provided, specifies the number of units by which the range or selection is to be moved.
unit If provided, specifies the unit by which to move the ending character position.
SelectionMoveStartEndOptions count If provided, specifies the number of units to move.
unit If provided, specifies the unit by which the selection's start or end position (per the calling method) is to be moved.
SelectionMoveUpDownOptions count If provided, specifies the number of units the selection is to be moved.
extend If provided, specifies the type of movement.
unit If provided, specifies the unit by which to move the selection.
SelectionNextOptions count If provided, specifies the number of units by which you want to move ahead.
unit If provided, specifies the type of units by which to move the selection.
SelectionPreviousOptions count If provided, specifies the number of units by which you want to move.
unit If provided, specifies the type of unit by which to move the selection.
TabStop alignment Gets a TabAlignment value that represents the alignment for the tab stop.
clear() Removes this custom tab stop.
customTab Gets whether this tab stop is a custom tab stop.
leader Gets a TabLeader value that represents the leader for this TabStop object.
next Gets the next tab stop in the collection.
position Gets the position of the tab stop relative to the left margin.
previous Gets the previous tab stop in the collection.
TabStopAddOptions alignment If provided, specifies the alignment of the tab stop.
leader If provided, specifies the leader character for the tab stop.
TabStopCollection add(position: number, options?: Word.TabStopAddOptions) Returns a TabStop object that represents a custom tab stop added to the paragraph.
after(Position: number) Returns the next TabStop object to the right of the specified position.
before(Position: number) Returns the next TabStop object to the left of the specified position.
clearAll() Clears all the custom tab stops from the paragraph.
items Gets the loaded child items in this collection.
Table applyStyleDirectFormatting(styleName: string) Applies the specified style but maintains any formatting that a user directly applies.
autoFitBehavior(behavior: Word.AutoFitBehavior) Determines how Microsoft Word resizes a table when the AutoFit feature is used.
autoFormat(options?: Word.TableAutoFormatOptions) Applies a predefined look to a table.
columns Returns the TableColumnCollection object that represents the columns in the table.
convertToText(options?: Word.TableConvertToTextOptions) Converts a table to text.
description Specifies the description of the table.
reapplyAutoFormat() Updates the table with the characteristics of the predefined table format set when the autoFormat method was called.
shading Returns the ShadingUniversal object that represents the shading of the table.
sort(options?: Word.TableSortOptions) Sorts the specified table.
title Specifies the title of the table.
TableAutoFormatOptions applyBorders If provided, specifies whether to apply borders of the specified format.
applyColor If provided, specifies whether to apply color of the specified format.
applyFirstColumn If provided, specifies whether to apply first column formatting of the specified format.
applyFont If provided, specifies whether to apply font of the specified format.
applyHeadingRows If provided, specifies whether to apply heading row formatting of the specified format.
applyLastColumn If provided, specifies whether to apply last column formatting of the specified format.
applyLastRow If provided, specifies whether to apply last row formatting of the specified format.
applyShading If provided, specifies whether to apply shading of the specified format.
autoFit If provided, specifies whether to decrease the width of the table columns as much as possible without changing the way text wraps in the cells.
format If provided, specifies the format to apply.
TableCell autoSum() Inserts a = (Formula) field that calculates and displays the sum of the values in table cells above or to the left of the cell specified in the expression.
column Returns the TableColumn object that represents the table column that contains this cell.
delete(shiftCells: any) Deletes the table cell and optionally controls how the remaining cells are shifted.
formula(options?: Word.TableCellFormulaOptions) Inserts a = (Formula) field that contains the specified formula into a table cell.
merge(mergeTo: Word.TableCell) Merges this table cell with the specified table cell.
select() Selects the table cell.
shading Returns the ShadingUniversal object that represents the shading of the table cell.
TableCellCollection autoFit() Changes the width of a table column to accommodate the width of the text without changing the way text wraps in the cells.
delete(shiftCells?: Word.DeleteCells) Deletes the table cells and optionally controls how the remaining cells are shifted.
distributeHeight() Adjusts the height of the specified cells so that they are equal.
distributeWidth() Adjusts the width of the specified cells so that they are equal.
merge() Merges the specified cells into a single cell.
setHeight(rowHeight: number, heightRule: Word.RowHeightRule) Sets the height of the cells in a table.
setWidth(columnWidth: number, rulerStyle: Word.RulerStyle) Sets the width of the cells in a table.
split(options?: Word.TableCellCollectionSplitOptions) Splits this range of table cells.
TableCellCollectionSplitOptions mergeBeforeSplit If provided, specifies whether to merge the cells with one another before splitting them.
numColumns If provided, specifies the number of columns that the group of cells is to be split into.
numRows If provided, specifies the number of rows that the group of cells is to be split into.
TableCellFormulaOptions formula If provided, specifies the mathematical formula you want the = (Formula) field to evaluate.
numFormat If provided, specifies a format for the result of the = (Formula) field.
TableConvertToTextOptions nestedTables If provided, specifies whether to convert the nested tables to text.
separator If provided, specifies the character that delimits the converted columns (paragraph marks delimit the converted rows).
TableOfAuthorities bookmark Specifies the name of the bookmark from which to collect table of authorities entries.
category Specifies the category of entries to be included in the table of authorities.
delete() Deletes this table of authorities.
entrySeparator Specifies a separator of up to five characters.
isCategoryHeaderIncluded Specifies whether the category name for a group of entries appears in the table of authorities.
isEntryFormattingKept Specifies whether the entries in the table of authorities are displayed with their formatting in the table.
isPassimUsed Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim".
pageNumberSeparator Specifies a separator of up to five characters.
pageRangeSeparator Specifies a separator of up to five characters.
range Gets the portion of a document that is this table of authorities.
sequenceName Specifies the Sequence (SEQ) field identifier for the table of authorities.
sequenceSeparator Specifies a separator of up to five characters.
tabLeader Specifies the leader character that appears between entries and their associated page numbers in the table of authorities.
TableOfAuthoritiesAddOptions bookmark If provided, specifies the string name of the bookmark from which to collect entries for a table of authorities.
category If provided, specifies the category of entries to include in a table of authorities.
entrySeparator If provided, specifies a separator of up to five characters.
includeCategoryHeader If provided, specifies whether the category name for each group of entries appears in a table of authorities (e.g., "Cases").
keepEntryFormatting If provided, specifies whether the entries in a table of authorities are displayed with their formatting in the table.
pageNumberSeparator If provided, specifies a separator of up to five characters.
pageRangeSeparator If provided, specifies a separator of up to five characters.
sequenceName If provided, specifies the string that identifies the Sequence (SEQ) field identifier for a table of authorities.
sequenceSeparator If provided, specifies a separator of up to five characters.
usePassim If provided, specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim".
TableOfAuthoritiesCategory name Specifies the name of this table of authorities category.
TableOfAuthoritiesCategoryCollection getCount() Returns the number of items in the collection.
getItemAt(index: number) Returns a TableOfAuthoritiesCategory object that represents the specified item in the collection.
items Gets the loaded child items in this collection.
TableOfAuthoritiesCollection add(range: Word.Range, options?: Word.TableOfAuthoritiesAddOptions) Adds a table of authorities to the document at the specified range.
items Gets the loaded child items in this collection.
markAllCitations(shortCitation: string, options?: Word.TableOfAuthoritiesMarkCitationOptions) Inserts a Table of Authorities Entry (TA) field after all instances of the specified citation text.
markCitation(range: Word.Range, shortCitation: string, options?: Word.TableOfAuthoritiesMarkCitationOptions) Inserts a Table of Authorities Entry (TA) field at the specified range.
selectNextCitation(shortCitation: string) Finds and selects the next instance of the specified citation text.
TableOfAuthoritiesMarkCitationOptions category If provided, specifies the category number to be associated with the entry.
longCitation If provided, specifies the long citation for the entry as it will appear in a table of authorities.
longCitationAutoText If provided, specifies the name of the AutoText entry that contains the text of the long citation as it will appear in a table of authorities.
TableOfContents additionalHeadingStyles Gets the additional styles used for the table of contents.
areBuiltInHeadingStylesUsed Specifies whether built-in heading styles are used for the table of contents.
areFieldsUsed Specifies whether Table of Contents Entry (TC) fields are included in the table of contents.
areHyperlinksUsedOnWeb Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web.
arePageNumbersHiddenOnWeb Specifies whether the page numbers in the table of contents should be hidden when publishing to the web.
arePageNumbersIncluded Specifies whether page numbers are included in the table of contents.
arePageNumbersRightAligned Specifies whether page numbers are aligned with the right margin in the table of contents.
delete() Deletes this table of contents.
lowerHeadingLevel Specifies the ending heading level for the table of contents.
range Gets the portion of a document that is this table of contents.
tabLeader Specifies the character between entries and their page numbers in the table of contents.
tableId Specifies a one-letter identifier from TC fields that's used for the table of contents.
updatePageNumbers() Updates the entire table of contents.
upperHeadingLevel Specifies the starting heading level for the table of contents.
TableOfContentsAddOptions addedStyles If provided, specifies the string names of additional styles to use for the table of contents.
hidePageNumbersOnWeb If provided, specifies whether the page numbers in a table of contents should be hidden when publishing to the web.
includePageNumbers If provided, specifies whether to include page numbers in a table of contents.
lowerHeadingLevel If provided, specifies the ending heading level for a table of contents and must be a value from 1 to 9.
rightAlignPageNumbers If provided, specifies whether page numbers in a table of contents are aligned with the right margin.
tableId If provided, specifies a one-letter identifier from TC fields that's used for a table of contents.
upperHeadingLevel If provided, specifies the starting heading level for a table of contents and must be a value from 1 to 9.
useBuiltInHeadingStyles If provided, specifies whether to use built-in heading styles to create a table of contents.
useFields If provided, specifies whether Table of Contents Entry (TC) fields are used to create a table of contents.
useHyperlinksOnWeb If provided, specifies whether entries in a table of contents should be formatted as hyperlinks when the document is published to the web.
useOutlineLevels If provided, specifies whether to use outline levels to create a table of contents.
TableOfContentsCollection add(range: Word.Range, options?: Word.TableOfContentsAddOptions) Adds a table of contents to the document at the specified range.
items Gets the loaded child items in this collection.
markTocEntry(range: Word.Range, options?: Word.TableOfContentsMarkEntryOptions) Inserts a Table of Contents Entry (TC) field after the specified range.
TableOfContentsMarkEntryOptions entry If provided, specifies the text that appears in a table of contents or table of figures.
entryAutoText If provided, specifies the AutoText entry name that includes text for the table of figures, or table of contents.
level If provided, specifies the level for the entry in a table of contents or table of figures and should be a value from 1 to 9.
tableId If provided, specifies a one-letter identifier for a table of contents or table of figures (e.g., "i" for an "illustration").
TableOfFigures additionalHeadingStyles Gets the additional styles used for the table of figures.
areBuiltInHeadingStylesUsed Specifies whether built-in heading styles are used for the table of figures.
areFieldsUsed Specifies whether Table of Contents Entry (TC) fields are included in the table of figures.
areHyperlinksUsedOnWeb Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web.
arePageNumbersHiddenOnWeb Specifies whether the page numbers in the table of figures should be hidden when publishing to the web.
arePageNumbersIncluded Specifies whether page numbers are included in the table of figures.
arePageNumbersRightAligned Specifies whether page numbers are aligned with the right margin in the table of figures.
captionLabel Specifies the label that identifies the items to be included in the table of figures.
delete() Deletes this table of figures.
isLabelIncluded Specifies whether the caption label and caption number are included in the table of figures.
lowerHeadingLevel Specifies the ending heading level for the table of figures.
range Gets the portion of a document that is this table of figures.
tabLeader Specifies the character between entries and their page numbers in the table of figures.
tableId Specifies a one-letter identifier from TC fields that's used for the table of figures.
updatePageNumbers() Updates the entire table of figures.
upperHeadingLevel Specifies the starting heading level for the table of figures.
TableOfFiguresAddOptions addedStyles If provided, specifies the string names of additional styles to use for the table of figures.
captionLabel If provided, specifies the label that identifies the items to include in a table of figures.
hidePageNumbersOnWeb If provided, specifies whether the page numbers in the table of figures should be hidden when publishing to the web.
includeLabel If provided, specifies whether to include the caption label and caption number in a table of figures.
includePageNumbers If provided, specifies whether page numbers are included in a table of figures.
lowerHeadingLevel If provided, specifies the ending heading level for a table of figures when useBuiltInHeadingStyles is set to true.
rightAlignPageNumbers If provided, specifies whether to align page numbers with the right margin in a table of figures.
tableId If provided, specifies a one-letter identifier from TC fields that's used for a table of figures.
upperHeadingLevel If provided, specifies the starting heading level for a table of figures when useBuiltInHeadingStyles is set to true.
useBuiltInHeadingStyles If provided, specifies whether to use built-in heading styles to create a table of figures.
useFields If provided, specifies whether to use Table of Contents Entry (TC) fields to create a table of figures.
useHyperlinksOnWeb If provided, specifies whether entries in a table of figures should be formatted as hyperlinks when the document is published to the web.
TableOfFiguresCollection add(range: Word.Range, options?: Word.TableOfFiguresAddOptions) Adds a table of figures to the document at the specified range.
items Gets the loaded child items in this collection.
markTocEntry(range: Word.Range, options?: Word.TableOfContentsMarkEntryOptions) Inserts a Table of Contents Entry (TC) field after the specified range for marking entries in a table of figures.
TableRow convertToText(options?: Word.TableConvertToTextOptions) Converts the table row to text.
range Returns the Range object that represents the table row.
setHeight(rowHeight: number, heightRule: Word.RowHeightRule) Sets the height of the row.
setLeftIndent(leftIndent: number, rulerStyle: Word.RulerStyle) Sets the left indent for the table row.
shading Returns the ShadingUniversal object that represents the shading of the table row.
TableRowCollection convertToText(options?: Word.TableConvertToTextOptions) Converts rows in a table to text.
delete() Deletes the table rows.
distributeHeight() Adjusts the height of the rows so that they're equal.
select() Selects the table rows.
setHeight(rowHeight: number, heightRule: Word.RowHeightRule) Sets the height of the cells in a table.
setLeftIndent(leftIndent: number, rulerStyle: Word.RulerStyle) Sets the left indent for the table row.
TableSortOptions bidirectionalSort If provided, specifies whether to use bidirectional sort.
caseSensitive If provided, specifies whether sorting is case-sensitive.
excludeHeader If provided, specifies whether to exclude the header row from the sort operation.
fieldNumber2 If provided, specifies the second field to sort by.
fieldNumber3 If provided, specifies the third field to sort by.
fieldNumber If provided, specifies the first field to sort by.
ignoreArabicThe If provided, specifies whether to ignore Arabic character alef lam when sorting right-to-left language text.
ignoreDiacritics If provided, specifies whether to ignore bidirectional control characters when sorting right-to-left language text.
ignoreHebrew If provided, specifies whether to ignore Hebrew characters when sorting right-to-left language text.
ignoreKashida If provided, specifies whether to ignore kashida when sorting right-to-left language text.
languageId If provided, specifies the sorting language.
sortFieldType2 If provided, specifies the type of the second field to sort by.
sortFieldType3 If provided, specifies the type of the third field to sort by.
sortFieldType If provided, specifies the type of the first field to sort by.
sortOrder2 If provided, specifies the sort order of the second field to sort by.
sortOrder3 If provided, specifies the sort order of the third field to sort by.
sortOrder If provided, specifies the sort order of the first field to sort by.
TableStyle borders Returns a BorderUniversalCollection that represents all the borders for the table.
columnStripe Specifies the number of columns in the banding when a style specifies odd- or even-column banding.
condition(conditionCode: Word.ConditionCode) Returns a ConditionalStyle object that represents special style formatting for a portion of a table.
isBreakAcrossPagesAllowed Specifies whether Microsoft Word allows to break the specified table across pages.
leftIndent Specifies the left indent value (in points) for the rows in the table style.
rowStripe Specifies the number of rows to include in the banding when the style specifies odd- or even-row banding.
shading Returns a ShadingUniversal object that refers to the shading formatting for the table style.
tableDirection Specifies the direction in which Microsoft Word orders cells in the table style.
Template listTemplates Returns a ListTemplateCollection object that represents all the list templates in the template.
View areAllNonprintingCharactersDisplayed Specifies whether all nonprinting characters are displayed.
areBackgroundsDisplayed Gets whether background colors and images are shown when the document is displayed in print layout view.
areBookmarksIndicated Gets whether square brackets are displayed at the beginning and end of each bookmark.
areCommentsDisplayed Specifies whether Microsoft Word displays the comments in the document.
areConnectingLinesToRevisionsBalloonDisplayed Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons.
areCropMarksDisplayed Gets whether crop marks are shown in the corners of pages to indicate where margins are located.
areDrawingsDisplayed Gets whether objects created with the drawing tools are displayed in print layout view.
areEditableRangesShaded Specifies whether shading is applied to the ranges in the document that users have permission to modify.
areFieldCodesDisplayed Specifies whether field codes are displayed.
areFormatChangesDisplayed Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled.
areInkAnnotationsDisplayed Specifies whether handwritten ink annotations are shown or hidden.
areInsertionsAndDeletionsDisplayed Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled.
areLinesWrappedToWindow Gets whether lines wrap at the right edge of the document window rather than at the right margin or the right column boundary.
areObjectAnchorsDisplayed Gets whether object anchors are displayed next to items that can be positioned in print layout view.
areOptionalBreaksDisplayed Gets whether Microsoft Word displays optional line breaks.
areOptionalHyphensDisplayed Gets whether optional hyphens are displayed.
areOtherAuthorsVisible Gets whether other authors' presence should be visible in the document.
arePageBoundariesDisplayed Gets whether the top and bottom margins and the gray area between pages in the document are displayed.
areParagraphsMarksDisplayed Gets whether paragraph marks are displayed.
arePicturePlaceholdersDisplayed Gets whether blank boxes are displayed as placeholders for pictures.
areRevisionsAndCommentsDisplayed Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled.
areSpacesIndicated Gets whether space characters are displayed.
areTableGridlinesDisplayed Specifies whether table gridlines are displayed.
areTabsDisplayed Gets whether tab characters are displayed.
areTextBoundariesDisplayed Gets whether dotted lines are displayed around page margins, text columns, objects, and frames in print layout view.
collapseAllHeadings() Collapses all the headings in the document.
collapseOutline(range: Word.Range) Collapses the text under the selection or the specified range by one heading level.
columnWidth Specifies the column width in Reading mode.
expandAllHeadings() Expands all the headings in the document.
expandOutline(range: Word.Range) Expands the text under the selection by one heading level.
fieldShading Gets on-screen shading for fields.
isDraft Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display.
isFirstLineOnlyDisplayed Specifies whether only the first line of body text is shown in outline view.
isFormatDisplayed Specifies whether character formatting is visible in outline view.
isFullScreen Specifies whether the window is in full-screen view.
isHiddenTextDisplayed Gets whether text formatted as hidden text is displayed.
isHighlightingDisplayed Gets whether highlight formatting is displayed and printed with the document.
isInConflictMode Specifies whether the document is in conflict mode view.
isInPanning Specifies whether Microsoft Word is in Panning mode.
isInReadingLayout Specifies whether the document is being viewed in reading layout view.
isMailMergeDataView Specifies whether mail merge data is displayed instead of mail merge fields.
isMainTextLayerVisible Specifies whether the text in the document is visible when the header and footer areas are displayed.
isPointerShownAsMagnifier Specifies whether the pointer is displayed as a magnifying glass in print preview.
isReadingLayoutActualView Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages.
isXmlMarkupVisible Specifies whether XML tags are visible in the document.
markupMode Specifies the display mode for tracked changes.
nextHeaderFooter() Moves to the next header or footer, depending on whether a header or footer is displayed in the view.
pageColor Specifies the page color in Reading mode.
pageMovementType Specifies the page movement type.
previousHeaderFooter() Moves to the previous header or footer, depending on whether a header or footer is displayed in the view.
readingLayoutTruncateMargins Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view.
revisionsBalloonSide Gets whether Word displays revision balloons in the left or right margin in the document.
revisionsBalloonWidth Specifies the width of the revision balloons.
revisionsBalloonWidthType Specifies how Microsoft Word measures the width of revision balloons.
revisionsFilter Gets the instance of a RevisionsFilter object.
seekView Specifies the document element displayed in print layout view.
showAllHeadings() Switches between showing all text (headings and body text) and showing only headings.
showHeading(level: number) Shows all headings up to the specified heading level and hides subordinate headings and body text.
splitSpecial Specifies the active window pane.
type Specifies the view type.
WebSettings allowPng Specifies whether PNG is allowed as an image format when saving a document as a webpage.
encoding Specifies the document encoding (code page or character set) to be used by the web browser when viewing the saved document.
folderSuffix Gets the folder suffix used when saving a document as a webpage with long file names and supporting files in a separate folder.
organizeInFolder Specifies whether supporting files are organized in a separate folder when saving the document as a webpage.
pixelsPerInch Specifies the density (pixels per inch) of graphics images and table cells on a webpage.
relyOnCSS Specifies whether cascading style sheets (CSS) are used for font formatting when viewing a saved document in a web browser.
relyOnVectorMarkupLanguage Specifies whether image files are not generated from drawing objects when saving a document as a webpage.
screenSize Specifies the ideal minimum screen size (width by height, in pixels) for viewing the saved document in a web browser.
targetBrowser Specifies the target browser for documents viewed in a web browser.
useDefaultFolderSuffix() Sets the folder suffix for the specified document to the default suffix for the language support you have selected or installed.
useLongFileNames Specifies whether long file names are used when saving the document as a webpage.
Window activate() Activates the window.
areRulersDisplayed Specifies whether rulers are displayed for the window or pane.
areScreenTipsDisplayed Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips.
areThumbnailsDisplayed Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window.
caption Specifies the caption text for the window that is displayed in the title bar of the document or application window.
close(options?: Word.WindowCloseOptions) Closes the window.
height Specifies the height of the window (in points).
horizontalPercentScrolled Specifies the horizontal scroll position as a percentage of the document width.
imeMode Specifies the default start-up mode for the Japanese Input Method Editor (IME).
index Gets the position of an item in a collection.
isActive Specifies whether the window is active.
isDocumentMapVisible Specifies whether the document map is visible.
isEnvelopeVisible Specifies whether the email message header is visible in the document window.
isHorizontalScrollBarDisplayed Specifies whether a horizontal scroll bar is displayed for the window.
isLeftScrollBarDisplayed Specifies whether the vertical scroll bar appears on the left side of the document window.
isRightRulerDisplayed Specifies whether the vertical ruler appears on the right side of the document window in print layout view.
isSplit Specifies whether the window is split into multiple panes.
isVerticalRulerDisplayed Specifies whether a vertical ruler is displayed for the window or pane.
isVerticalScrollBarDisplayed Specifies whether a vertical scroll bar is displayed for the window.
isVisible Specifies whether the window is visible.
largeScroll(options?: Word.WindowScrollOptions) Scrolls the window by the specified number of screens.
left Specifies the horizontal position of the window, measured in points.
next Gets the next document window in the collection of open document windows.
pageScroll(options?: Word.WindowPageScrollOptions) Scrolls through the window page by page.
previous Gets the previous document window in the collection open document windows.
setFocus() Sets the focus of the document window to the body of an email message.
showSourceDocuments Specifies how Microsoft Word displays source documents after a compare and merge process.
smallScroll(options?: Word.WindowScrollOptions) Scrolls the window by the specified number of lines.
splitVertical Specifies the vertical split percentage for the window.
styleAreaWidth Specifies the width of the style area in points.
toggleRibbon() Shows or hides the ribbon.
top Specifies the vertical position of the document window, in points.
type Gets the window type.
usableHeight Gets the height (in points) of the active working area in the document window.
usableWidth Gets the width (in points) of the active working area in the document window.
verticalPercentScrolled Specifies the vertical scroll position as a percentage of the document length.
view Gets the View object that represents the view for the window.
width Specifies the width of the document window, in points.
windowNumber Gets an integer that represents the position of the window.
WindowCloseOptions routeDocument If provided, specifies whether to route the document to the next recipient.
saveChanges If provided, specifies the save action for the document.
WindowPageScrollOptions down If provided, specifies the number of pages to scroll the window down.
up If provided, specifies the number of pages to scroll the window up.
WindowScrollOptions down If provided, specifies the number of units to scroll the window down.
left If provided, specifies the number of screens to scroll the window to the left.
right If provided, specifies the number of screens to scroll the window to the right.
up If provided, specifies the number of units to scroll the window up.
XmlNode attributes Gets the attributes for this XML node.
baseName Gets the name of the element without any prefix.
childNodes Gets the child elements of this XML node.
copy() Copies this XML node, excluding XML markup, to the Clipboard.
cut() Removes this XML node from the document and places it on the Clipboard.
delete() Deletes the XML node from the XML document.
firstChild Gets the first child node if this is a parent node.
hasChildNodes Gets whether this XML node has child nodes.
lastChild Gets the last child node if this is a parent node.
level Gets whether this XML element is part of a paragraph, is a paragraph, or is contained within a table cell or contains a table row.
namespaceUri Gets the Uniform Resource Identifier (URI) of the schema namespace for this XML node.
nextSibling Gets the next element in the document that's at the same level as this XML node.
ownerDocument Gets the parent document of this XML node.
parentNode Gets the parent element of this XML node.
placeholderText Specifies the text displayed for this element if it contains no text.
previousSibling Gets the previous element in the document that's at the same level as this XML node.
range Gets the portion of a document that is contained in this XML node.
removeChild(childElement: Word.XmlNode) Removes a child element from this XML node.
selectNodes(xPath: string, options?: Word.SelectNodesOptions) Returns all the child elements that match the XPath parameter, in the order in which they appear within this XML node.
selectSingleNode(xPath: string, options?: Word.SelectSingleNodeOptions) Returns the first child element that matches the XPath parameter within this XML node.
setValidationError(status: Word.XmlValidationStatus, options?: Word.XmlNodeSetValidationErrorOptions) Changes the validation error text displayed to a user for this XML node and whether to force Word to report the node as invalid.
text Specifies the text contained within the XML element.
validate() Validates this XML node against the XML schemas that are attached to the document.
validationErrorText Gets the description for a validation error on this XmlNode object.
validationStatus Gets whether this element is valid according to the attached schema.
XmlNodeCollection getItemAt(index: number) Returns an individual XmlNode object in a collection.
items Gets the loaded child items in this collection.
XmlNodeSetValidationErrorOptions clearedAutomatically If provided, specifies whether the validation error should be cleared automatically.
errorText If provided, specifies the error text to display for the validation error.

See also