word-js-docs

Word JS API Docs

TypeScript Definitions

• Office JS TypeScript Definitions - TypeScript type definitions for Office JS APIs

Basics

• Basic API call (JavaScript) - Performs a basic Word API call using plain JavaScript & Promises.
• Basic API call (TypeScript) - Performs a basic Word API call using TypeScript.
• Basic API call (Office 2013) - Performs a basic Word API call using JavaScript with the “common API” syntax (compatible with Office 2013).

Content Controls

• On adding content controls - Registers, triggers, and deregisters onAdded event that tracks the addition of content controls.
• On changing data in content controls - Registers, triggers, and deregisters onDataChanged event that tracks when data is changed in content controls.
• On deleting content controls - Registers, triggers, and deregisters onDeleted event that tracks the removal of content controls.
• On entering content controls - Registers, triggers, and deregisters onEntered event that tracks when the cursor is placed within content controls.
• On exiting content controls - Registers, triggers, and deregisters onExited event that tracks when the cursor is removed from within content controls.
• On changing selection in content controls - Registers, triggers, and deregisters onSelectionChanged event that tracks when selections are changed in content controls.
• Get change tracking states of content controls - Gets change tracking states of content controls.
• Manage checkbox content controls - Inserts, updates, retrieves, and deletes checkbox content controls.
• Manage combo box content controls - Inserts, updates, and deletes combo box content controls.
• Content control basics - Inserts, updates, and retrieves content controls.
• Manage dropdown list content controls - Inserts, updates, and deletes dropdown list content controls.

Images

• Use inline pictures - Inserts and gets inline pictures.

Lists

• Create a list - Inserts a new list into the document.
• Get list styles - This sample shows how to get the list styles in the current document.
• Organize a list - Shows how to create and organize a list.

Paragraph

• Get paragraph from insertion point - Gets the full paragraph containing the insertion point.
• Get text - Shows how to get paragraph text, including hidden text and text marked for deletion.
• Get word count - Counts how many times a word or term appears in the document.
• Insert formatted text - Formats text with pre-built and custom styles.
• Insert headers and footers - Inserts headers and footers in the document.
• Insert content at different locations - Inserts content at different document locations.
• Insert breaks - Inserts page and line breaks in a document.
• On adding paragraphs - Registers, triggers, and deregisters the onParagraphAdded event that tracks the addition of paragraphs.
• On changing content in paragraphs - Registers, triggers, and deregisters the onParagraphChanged event that tracks when content is changed in paragraphs.
• On deleting paragraphs - Registers, triggers, and deregisters the onParagraphDeleted event that tracks the removal of paragraphs.
• Paragraph properties - Sets indentation, space between paragraphs, and other paragraph properties.
• Search - Shows basic and advanced search capabilities.

Properties

• Built-in document properties - Gets built-in document properties.
• Custom document properties - Adds and reads custom document properties of different types.

Ranges

• Compare range locations - This sample shows how to compare the locations of two ranges.
• Scroll to a range - Scrolls to a range with and without selection.
• Split a paragraph into ranges - Splits a paragraph into word ranges and then traverses all the ranges to format each word, producing a “karaoke” effect.

Tables

• Manage custom table style - Shows how to manage primarily margins and alignments of a custom table style in the current document.
• Table formatting - Gets the formatting details of a table, a table row, and a table cell, including borders, alignment, and cell padding.
• Create and access a table - Creates a table and accesses a specific cell.

Document

• Compare documents - Compares two documents (the current one and a specified external one).
• Get styles from external document - This sample shows how to get styles from an external document.
• Insert an external document - Inserts the content (with or without settings) of an external document into the current document. Settings include formatting, change-tracking mode, custom properties, and XML parts.
• Add a section - Shows how to insert section breaks in the document.
• Manage annotations - Shows how to leverage the Writing Assistance API to manage annotations and use annotation events.
• Manage body - Shows how to manage the document body.
• Track changes - This sample shows how to get and set the change tracking mode and get the before and after of reviewed text.
• Manage comments - This sample shows how to perform basic comments operations, including insert, reply, get, edit, resolve, and delete.
• Manage a CustomXmlPart with the namespace - This sample shows how to add, query, replace, edit, and delete a custom XML part in a document.
• Manage a CustomXmlPart without the namespace - This sample shows how to add, query, edit, and delete a custom XML part in a document.
• Manage fields - This sample shows how to perform basic operations on fields, including insert, get, and delete.
• Manage footnotes - This sample shows how to perform basic footnote operations, including insert, get, and delete.
• Manage settings - This sample shows how to add, edit, get, and delete custom settings on a document.
• Manage styles - This sample shows how to perform operations on the styles in the current document and how to add and delete custom styles.
• Manage tracked changes - This samples shows how to manage tracked changes, including accepting and rejecting changes.
• Manage document save and close - Shows how to manage saving and closing document.

Scenarios

• Correlated objects pattern - Shows the performance benefits of avoiding context.sync calls in a loop.
• Document assembly - Composes different parts of a Word document.
• Set multiple properties at once - Sets multiple properties at once with the API object set() method.

Preview Apis

• Content control basics - Inserts, updates, and retrieves content controls.
• Manage comments - This sample shows how to perform operations on comments (including insert, reply, get, edit, resolve, and delete) and use comment events.

Other

• Blank snippet - Creates a new snippet from a blank template.