Word JavaScript preview APIs

New Word JavaScript APIs are first introduced in "preview" and later become part of a specific, numbered requirement set after sufficient testing occurs and user feedback is acquired.

Important

Note that the following Word preview APIs are only available on the following platforms.

  • Word on Windows

Word preview APIs are currently not supported on Mac, iOS, or on the Web.

Note

Preview APIs are subject to change and are not intended for use in a production environment. We recommend that you try them out in test and development environments only. Do not use preview APIs in a production environment or within business-critical documents.

To use preview APIs:

API list

The following table lists the Word JavaScript APIs currently in preview. To see a complete list of all Word JavaScript APIs (including preview APIs and previously released APIs), see all Word JavaScript APIs.

Class Fields Description
ContentControl onDataChanged Occurs when data within the content control are changed.
onDeleted Occurs when the content control is deleted.
onSelectionChanged Occurs when selection within the content control is changed.
ContentControlEventArgs contentControl The object that raised the event.
eventType The event type.
CustomXmlPart delete() Deletes the custom XML part.
deleteAttribute(xpath: string, namespaceMappings: any, name: string) Deletes an attribute with the given name from the element identified by xpath.
deleteElement(xpath: string, namespaceMappings: any) Deletes the element identified by xpath.
getXml() Gets the full XML content of the custom XML part.
insertAttribute(xpath: string, namespaceMappings: any, name: string, value: string) Inserts an attribute with the given name and value to the element identified by xpath.
insertElement(xpath: string, xml: string, namespaceMappings: any, index?: number) Inserts the given XML under the parent element identified by xpath at child position index.
query(xpath: string, namespaceMappings: any) Queries the XML content of the custom XML part.
id Gets the ID of the custom XML part.
namespaceUri Gets the namespace URI of the custom XML part.
setXml(xml: string) Sets the full XML content of the custom XML part.
updateAttribute(xpath: string, namespaceMappings: any, name: string, value: string) Updates the value of an attribute with the given name of the element identified by xpath.
updateElement(xpath: string, xml: string, namespaceMappings: any) Updates the XML of the element identified by xpath.
CustomXmlPartCollection add(xml: string) Adds a new custom XML part to the document.
getByNamespace(namespaceUri: string) Gets a new scoped collection of custom XML parts whose namespaces match the given namespace.
getCount() Gets the number of items in the collection.
getItem(id: string) Gets a custom XML part based on its ID.
getItemOrNullObject(id: string) Gets a custom XML part based on its ID.
items Gets the loaded child items in this collection.
CustomXmlPartScopedCollection getCount() Gets the number of items in the collection.
getItem(id: string) Gets a custom XML part based on its ID.
getItemOrNullObject(id: string) Gets a custom XML part based on its ID.
getOnlyItem() If the collection contains exactly one item, this method returns it.
getOnlyItemOrNullObject() If the collection contains exactly one item, this method returns it.
items Gets the loaded child items in this collection.
Document deleteBookmark(name: string) Deletes a bookmark, if it exists, from the document.
getBookmarkRange(name: string) Gets a bookmark's range.
getBookmarkRangeOrNullObject(name: string) Gets a bookmark's range.
customXmlParts Gets the custom XML parts in the document.
onContentControlAdded Occurs when a content control is added.
settings Gets the add-in's settings in the document.
DocumentCreated deleteBookmark(name: string) Deletes a bookmark, if it exists, from the document.
getBookmarkRange(name: string) Gets a bookmark's range.
getBookmarkRangeOrNullObject(name: string) Gets a bookmark's range.
customXmlParts Gets the custom XML parts in the document.
settings Gets the add-in's settings in the document.
InlinePicture imageFormat Gets the format of the inline image.
List getLevelFont(level: number) Gets the font of the bullet, number, or picture at the specified level in the list.
getLevelPicture(level: number) Gets the base64 encoded string representation of the picture at the specified level in the list.
resetLevelFont(level: number, resetFontName?: boolean) Resets the font of the bullet, number, or picture at the specified level in the list.
setLevelPicture(level: number, base64EncodedImage?: string) Sets the picture at the specified level in the list.
Range getBookmarks(includeHidden?: boolean, includeAdjacent?: boolean) Gets the names all bookmarks in or overlapping the range.
insertBookmark(name: string) Inserts a bookmark on the range.
Setting delete() Deletes the setting.
key Gets the key of the setting.
value Gets or sets the value of the setting.
SettingCollection add(key: string, value: any) Creates a new setting or sets an existing setting.
deleteAll() Deletes all settings in this add-in.
getCount() Gets the count of settings.
getItem(key: string) Gets a setting object by its key, which is case-sensitive.
getItemOrNullObject(key: string) Gets a setting object by its key, which is case-sensitive.
items Gets the loaded child items in this collection.
Table mergeCells(topRow: number, firstCell: number, bottomRow: number, lastCell: number) Merges the cells bounded inclusively by a first and last cell.
TableCell split(rowCount: number, columnCount: number) Splits the cell into the specified number of rows and columns.
TableRow insertContentControl() Inserts a content control on the row.
merge() Merges the row into one cell.

See also