index.mdx

title	Document API reference
sidebarTitle	Reference
description	Operation reference from the canonical Document API contract.

{/* GENERATED FILE: DO NOT EDIT. Regenerate via pnpm run docapi:sync. */}

This reference is sourced from packages/document-api/src/contract/*.

<style>{` table th, table td { font-size: calc(1em - 2px); } `}</style>

Browse by namespace

Namespace	Canonical ops	Aliases	Total surface	Reference
Core	14	0	14	Open
Blocks	3	0	3	Open
Capabilities	1	0	1	Open
Create	6	0	6	Open
Sections	18	0	18	Open
Format	45	1	46	Open
Styles	1	0	1	Open
Lists	39	0	39	Open
Comments	5	0	5	Open
Track Changes	3	0	3	Open
Query	1	0	1	Open
Mutations	2	0	2	Open
Paragraph Formatting	19	0	19	Open
Paragraph Styles	2	0	2	Open
Tables	47	0	47	Open
History	3	0	3	Open
Table of Contents	10	0	10	Open
Images	27	0	27	Open
Hyperlinks	6	0	6	Open
Headers & Footers	9	0	9	Open
Content Controls	55	0	55	Open
Bookmarks	5	0	5	Open
Footnotes	6	0	6	Open
Cross-References	5	0	5	Open
Index	11	0	11	Open
Captions	6	0	6	Open
Fields	5	0	5	Open
Citations	15	0	15	Open
Table of Authorities	11	0	11	Open
Ranges	1	0	1	Open
Selection	1	0	1	Open
Diff	3	0	3	Open
Protection	3	0	3	Open
Permission Ranges	5	0	5	Open
Custom XML	5	0	5	Open
Anchored Metadata	6	0	6	Open

Available operations

The tables below are grouped by namespace.

Core

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>get	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.get(...)	Read the full document as an SDDocument structure.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>find	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.find(...)	Search the document for text or node matches using SDM/1 selectors. Returns discovery-grade results: for mutation targeting, use query.match instead.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>getNode	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.getNode(...)	Retrieve a single node by target position.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>getNodeById	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.getNodeById(...)	Retrieve a single node by its unique ID.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>getText	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.getText(...)	Extract the plain-text content of the document.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>getMarkdown	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.getMarkdown(...)	Extract the document content as a Markdown string.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>getHtml	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.getHtml(...)	Extract the document content as an HTML string.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>markdownToFragment	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.markdownToFragment(...)	Convert a Markdown string into an SDM/1 structural fragment.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>info	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.info(...)	Return document summary info including word, character, paragraph, heading, table, image, comment, tracked-change, SDT-field, list, and page counts, plus outline and capabilities.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>extract	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.extract(...)	Extract all document content with stable IDs for RAG pipelines. Returns blocks with full text, comments, and tracked changes: each with an ID compatible with scrollToElement().
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>clearContent	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.clearContent(...)	Clear all document body content, leaving a single empty paragraph.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>insert	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.insert(...)	Insert content into the document. Two input shapes: text-based (value + type) inserts inline content at a SelectionTarget or ref position within an existing block; structural SDFragment (content) inserts one or more blocks as siblings relative to a BlockNodeAddress target. When target/ref is omitted, content appends at the end of the document. Text mode supports text (default), markdown, and html content types via the type field. Structural mode uses placement (before/after/insideStart/insideEnd) to position relative to the target block.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>replace	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.replace(...)	Replace content at a contiguous document selection. Text path accepts a SelectionTarget or ref plus replacement text. Structural path accepts a BlockNodeAddress (replaces whole block), SelectionTarget (expands to full covered block boundaries), or ref plus SDFragment content.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>delete	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.delete(...)	Delete content at a contiguous document selection. Accepts a SelectionTarget or mutation-ready ref. Supports cross-block deletion and optional block-edge expansion via behavior mode.

Blocks

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>blocks.list	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.blocks.list(...)	List top-level blocks in document order with IDs, types, text previews, and optional full text when includeText:true. Supports pagination via offset/limit and optional nodeType filtering.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>blocks.delete	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.blocks.delete(...)	Delete an entire block node (paragraph, heading, list item, table, image, or sdt) deterministically.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>blocks.deleteRange	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.blocks.deleteRange(...)	Delete a contiguous range of top-level blocks between two endpoints (inclusive). Both endpoints must be direct children of the document node. Supports dry-run preview.

Capabilities

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>capabilities.get	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.capabilities()	Query runtime capabilities supported by the current document engine.

Create

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>create.paragraph	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.create.paragraph(...)	Create a standalone paragraph at the target position. To add a list item, use lists.insert instead.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>create.heading	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.create.heading(...)	Create a new heading at the target position.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>create.sectionBreak	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.create.sectionBreak(...)	Create a section break at the target location with optional initial section properties.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>create.table	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.create.table(...)	Create a new table at the target position.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>create.tableOfContents	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.create.tableOfContents(...)	Insert a new table of contents at the target position.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>create.image	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.create.image(...)	Insert a new image at the target position.

Sections

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>sections.list	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.sections.list(...)	List sections in deterministic order with section-target handles.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>sections.get	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.sections.get(...)	Retrieve full section information by section address.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>sections.setBreakType	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.sections.setBreakType(...)	Set the section break type.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>sections.setPageMargins	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.sections.setPageMargins(...)	Set page-edge margins for a section.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>sections.setHeaderFooterMargins	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.sections.setHeaderFooterMargins(...)	Set header/footer margin distances for a section.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>sections.setPageSetup	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.sections.setPageSetup(...)	Set page size/orientation properties for a section.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>sections.setColumns	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.sections.setColumns(...)	Set column configuration for a section.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>sections.setLineNumbering	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.sections.setLineNumbering(...)	Enable or configure line numbering for a section.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>sections.setPageNumbering	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.sections.setPageNumbering(...)	Set page numbering format/start and chapter numbering settings for a section.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>sections.setTitlePage	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.sections.setTitlePage(...)	Enable or disable title-page behavior for a section.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>sections.setOddEvenHeadersFooters	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.sections.setOddEvenHeadersFooters(...)	Enable or disable odd/even header-footer mode in document settings.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>sections.setVerticalAlign	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.sections.setVerticalAlign(...)	Set vertical page alignment for a section.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>sections.setSectionDirection	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.sections.setSectionDirection(...)	Set section text flow direction (LTR/RTL).
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>sections.setHeaderFooterRef	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.sections.setHeaderFooterRef(...)	Set or replace a section header/footer reference for a variant.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>sections.clearHeaderFooterRef	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.sections.clearHeaderFooterRef(...)	Clear a section header/footer reference for a specific variant.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>sections.setLinkToPrevious	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.sections.setLinkToPrevious(...)	Set or clear link-to-previous behavior for a header/footer variant.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>sections.setPageBorders	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.sections.setPageBorders(...)	Set page border configuration for a section.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>sections.clearPageBorders	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.sections.clearPageBorders(...)	Clear page border configuration for a section.

Format

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>formatRange	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.formatRange(...)	Legacy root-level alias for inline range formatting. Routes to format.apply for compatibility with older callers.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.apply	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.apply(...)	Apply inline run-property patch changes to the target range with explicit set/clear semantics.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.bold	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.bold(...)	Set or clear the bold inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.italic	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.italic(...)	Set or clear the italic inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.strike	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.strike(...)	Set or clear the strike inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.underline	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.underline(...)	Set or clear the underline inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.highlight	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.highlight(...)	Set or clear the highlight inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.color	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.color(...)	Set or clear the color inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.fontSize	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.fontSize(...)	Set or clear the fontSize inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.fontFamily	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.fontFamily(...)	Set or clear the fontFamily inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.letterSpacing	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.letterSpacing(...)	Set or clear the letterSpacing inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.vertAlign	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.vertAlign(...)	Set or clear the vertAlign inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.position	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.position(...)	Set or clear the position inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.dstrike	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.dstrike(...)	Set or clear the dstrike inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.smallCaps	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.smallCaps(...)	Set or clear the smallCaps inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.caps	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.caps(...)	Set or clear the caps inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.shading	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.shading(...)	Set or clear the shading inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.border	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.border(...)	Set or clear the border inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.outline	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.outline(...)	Set or clear the outline inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.shadow	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.shadow(...)	Set or clear the shadow inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.emboss	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.emboss(...)	Set or clear the emboss inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.imprint	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.imprint(...)	Set or clear the imprint inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.charScale	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.charScale(...)	Set or clear the charScale inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.kerning	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.kerning(...)	Set or clear the kerning inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.vanish	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.vanish(...)	Set or clear the vanish inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.webHidden	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.webHidden(...)	Set or clear the webHidden inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.specVanish	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.specVanish(...)	Set or clear the specVanish inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.rtl	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.rtl(...)	Set or clear the rtl inline run property on the target text range. This does not change paragraph direction; use format.paragraph.setDirection for paragraph-level RTL.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.cs	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.cs(...)	Set or clear the cs inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.bCs	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.bCs(...)	Set or clear the bCs inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.iCs	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.iCs(...)	Set or clear the iCs inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.eastAsianLayout	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.eastAsianLayout(...)	Set or clear the eastAsianLayout inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.em	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.em(...)	Set or clear the em inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.fitText	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.fitText(...)	Set or clear the fitText inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.snapToGrid	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.snapToGrid(...)	Set or clear the snapToGrid inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.lang	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.lang(...)	Set or clear the lang inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.oMath	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.oMath(...)	Set or clear the oMath inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.rStyle	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.rStyle(...)	Set or clear the rStyle inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.rFonts	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.rFonts(...)	Set or clear the rFonts inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.fontSizeCs	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.fontSizeCs(...)	Set or clear the fontSizeCs inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.ligatures	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.ligatures(...)	Set or clear the ligatures inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.numForm	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.numForm(...)	Set or clear the numForm inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.numSpacing	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.numSpacing(...)	Set or clear the numSpacing inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.stylisticSets	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.stylisticSets(...)	Set or clear the stylisticSets inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.contextualAlternates	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.contextualAlternates(...)	Set or clear the contextualAlternates inline run property on the target text range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.strikethrough	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.strikethrough(...)	Convenience alias for format.strike with value: true.

Styles

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>styles.apply	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.styles.apply(...)	Apply document-level default style changes to the stylesheet (word/styles.xml). Targets docDefaults run and paragraph channels with set-style patch semantics.

Lists

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.list	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.list(...)	List all list nodes in the document, optionally filtered by scope.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.get	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.get(...)	Retrieve a specific list node by target.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.insert	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.insert(...)	Insert a new list item before or after an existing list item. The new item inherits the target list context.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.create	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.create(...)	Create a new list from one or more paragraphs. Supports optional preset or style for new sequences. When sequence.mode is "continuePrevious", preset and style are not allowed: the new items inherit formatting from the previous sequence.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.attach	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.attach(...)	Convert non-list paragraphs to list items under an existing list sequence.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.detach	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.detach(...)	Remove numbering properties from list items, converting them to plain paragraphs.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.delete	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.delete(...)	Delete the entire list that contains the targeted list item. Removes ALL items in the same numbered sequence (the contiguous run of list items sharing the target's numbering) AND their text content from the document. Pass any single list item from the list as target; the op walks adjacent siblings to find the full list. Use this for "remove the list" / "delete this list" intents and for the cleanup step of a list-to-table conversion.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.indent	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.indent(...)	Increase the indentation level of a list item.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.outdent	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.outdent(...)	Decrease the indentation level of a list item.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.join	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.join(...)	Merge two adjacent list sequences into one.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.canJoin	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.canJoin(...)	Check whether two adjacent list sequences can be joined.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.separate	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.separate(...)	Split a list sequence at the target item, creating a new sequence from that point forward.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.merge	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.merge(...)	Compound: merge two adjacent list sequences into one. Reassigns numId on the absorbed sequence (no strict abstractNumId check: absorbed items adopt the absorbing definition) and deletes empty paragraphs between the two sequences. Use this instead of lists.join for the user-facing "merge these lists" intent.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.split	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.split(...)	Compound: split a list sequence at the target item into two independent sequences. Runs lists.separate then (by default) lists.setValue(1) so the new half starts numbering fresh at 1. Pass restartNumbering:false for raw separate semantics (new half continues the previous count).
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.setLevel	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.setLevel(...)	Set the absolute nesting level (0..8) of a list item.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.setValue	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.setValue(...)	Set an explicit numbering value at the target item. Mid-sequence targets are atomically separated first.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.continuePrevious	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.continuePrevious(...)	Continue numbering from the nearest compatible previous list sequence.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.canContinuePrevious	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.canContinuePrevious(...)	Check whether the target sequence can continue numbering from a previous compatible sequence.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.setLevelRestart	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.setLevelRestart(...)	Set the restart behavior for a specific list level.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.convertToText	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.convertToText(...)	Convert list items to plain paragraphs, optionally prepending the rendered marker text.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.applyTemplate	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.applyTemplate(...)	Advanced alias for lists.applyStyle. Apply a captured ListTemplate to the target list (abstract-scoped, no clone-on-write).
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.applyPreset	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.applyPreset(...)	Apply a built-in list formatting preset to the target list.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.setType	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.setType(...)	Convert a list to ordered or bullet and merge adjacent compatible sequences to preserve continuous numbering.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.captureTemplate	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.captureTemplate(...)	Advanced alias for lists.getStyle. Capture list formatting from the abstract definition only (does not merge lvlOverride formatting).
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.setLevelNumbering	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.setLevelNumbering(...)	Advanced alias for lists.setLevelNumberStyle/setLevelText/setLevelStart. Set format, pattern, and start in one call (abstract-scoped, no clone-on-write).
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.setLevelBullet	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.setLevelBullet(...)	Set the bullet marker text for a specific list level.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.setLevelPictureBullet	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.setLevelPictureBullet(...)	Set a picture bullet for a specific list level by its OOXML lvlPicBulletId.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.setLevelAlignment	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.setLevelAlignment(...)	Set the marker alignment (left, center, right) for a specific list level.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.setLevelIndents	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.setLevelIndents(...)	Set the paragraph indentation values (left, hanging, firstLine) for a specific list level.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.setLevelTrailingCharacter	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.setLevelTrailingCharacter(...)	Set the trailing character (tab, space, nothing) after the marker for a specific list level.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.setLevelMarkerFont	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.setLevelMarkerFont(...)	Set the font family used for the marker character at a specific list level.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.clearLevelOverrides	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.clearLevelOverrides(...)	Remove instance-level overrides for a specific list level, restoring abstract definition values.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.getStyle	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.getStyle(...)	Read the effective reusable style of a list, including instance-level overrides. Returns a ListStyle that can be applied to other lists via lists.applyStyle.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.applyStyle	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.applyStyle(...)	Apply a reusable list style to the target list. Sequence-local: if the abstract definition is shared with other lists, it is cloned first to avoid affecting them.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.restartAt	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.restartAt(...)	Restart numbering at the target list item with a specific value. If the item is mid-sequence, it is separated first.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.setLevelNumberStyle	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.setLevelNumberStyle(...)	Set the numbering style (e.g. decimal, lowerLetter, upperRoman) for a specific list level. Rejects "bullet": use setLevelBullet instead. Sequence-local: clones shared definitions.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.setLevelText	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.setLevelText(...)	Set the level text pattern (e.g. "%1.", "(%1)") for a specific list level. Uses OOXML level-placeholder syntax. Sequence-local: clones shared definitions.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.setLevelStart	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.setLevelStart(...)	Set the start value for a specific list level. Rejects bullet levels and non-positive values. Sequence-local: clones shared definitions.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>lists.setLevelLayout	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.lists.setLevelLayout(...)	Set the layout properties (alignment, indentation, trailing character, tab stop) for a specific list level. Accepts partial updates: omitted fields are left unchanged. Sequence-local: clones shared definitions.

Comments

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>comments.create	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.comments.create(...)	Create a new comment thread (or reply when parentCommentId is given).
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>comments.patch	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.comments.patch(...)	Patch fields on an existing comment (text, target, status, or isInternal).
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>comments.delete	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.comments.delete(...)	Remove a comment or reply by ID.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>comments.get	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.comments.get(...)	Retrieve a single comment thread by ID.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>comments.list	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.comments.list(...)	List all comment threads in the document.

Track Changes

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>trackChanges.list	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.trackChanges.list(...)	List all tracked changes in the document.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>trackChanges.get	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.trackChanges.get(...)	Retrieve a single tracked change by ID.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>trackChanges.decide	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.trackChanges.decide(...)	Accept or reject tracked changes by ID, range, or scope: all (optionally filtered by story).

Query

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>query.match	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.query.match(...)	Deterministic selector-based search returning mutation-grade addresses and text ranges. Use this to discover targets before any mutation.

Mutations

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>mutations.preview	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.mutations.preview(...)	Dry-run a mutation plan, returning resolved targets without applying changes.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>mutations.apply	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.mutations.apply(...)	Execute a mutation plan atomically against the document.

Paragraph Formatting

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.paragraph.resetDirectFormatting	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.paragraph.resetDirectFormatting(...)	Strip all direct paragraph formatting while preserving style reference, numbering, and section metadata.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.paragraph.setAlignment	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.paragraph.setAlignment(...)	Set visual paragraph alignment on a paragraph-like block. For RTL paragraphs, left/right are translated to Word-compatible stored justification values.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.paragraph.clearAlignment	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.paragraph.clearAlignment(...)	Remove direct paragraph alignment, reverting to style-defined or default alignment.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.paragraph.setIndentation	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.paragraph.setIndentation(...)	Set paragraph indentation properties (left, right, firstLine, hanging) in twips.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.paragraph.clearIndentation	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.paragraph.clearIndentation(...)	Remove all direct paragraph indentation.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.paragraph.setSpacing	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.paragraph.setSpacing(...)	Set paragraph spacing properties (before, after, line, lineRule) in twips.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.paragraph.clearSpacing	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.paragraph.clearSpacing(...)	Remove all direct paragraph spacing.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.paragraph.setKeepOptions	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.paragraph.setKeepOptions(...)	Set keep-with-next, keep-lines-together, and widow/orphan control flags.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.paragraph.setOutlineLevel	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.paragraph.setOutlineLevel(...)	Set the paragraph outline level (0–9) or null to clear.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.paragraph.setFlowOptions	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.paragraph.setFlowOptions(...)	Set contextual spacing, page-break-before, and suppress-auto-hyphens flags.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.paragraph.setTabStop	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.paragraph.setTabStop(...)	Add or replace a tab stop at a given position.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.paragraph.clearTabStop	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.paragraph.clearTabStop(...)	Remove a tab stop at a given position.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.paragraph.clearAllTabStops	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.paragraph.clearAllTabStops(...)	Remove all tab stops from a paragraph.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.paragraph.setBorder	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.paragraph.setBorder(...)	Set border properties for a specific side of a paragraph.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.paragraph.clearBorder	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.paragraph.clearBorder(...)	Remove border for a specific side or all sides of a paragraph.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.paragraph.setShading	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.paragraph.setShading(...)	Set paragraph shading (background fill, pattern color, pattern type).
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.paragraph.clearShading	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.paragraph.clearShading(...)	Remove all paragraph shading.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.paragraph.setDirection	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.paragraph.setDirection(...)	Set paragraph base direction (LTR or RTL via w:bidi). Optionally align text to match.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>format.paragraph.clearDirection	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.format.paragraph.clearDirection(...)	Remove explicit paragraph direction, reverting to inherited or default (LTR).

Paragraph Styles

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>styles.paragraph.setStyle	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.styles.paragraph.setStyle(...)	Apply a paragraph style (w:pStyle) to a paragraph-like block, clearing direct run formatting while preserving character-style references.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>styles.paragraph.clearStyle	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.styles.paragraph.clearStyle(...)	Remove the paragraph style reference from a paragraph-like block.

Tables

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.convertFromText	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.convertFromText(...)	Convert a text range into a table.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.delete	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.delete(...)	Delete the target table from the document.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.clearContents	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.clearContents(...)	Clear the contents of the target table or cell range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.move	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.move(...)	Move a table to a new position in the document.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.split	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.split(...)	Split a table into two tables at the target row.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.convertToText	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.convertToText(...)	Convert a table back to plain text.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.setLayout	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.setLayout(...)	Set the layout mode of the target table.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.insertRow	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.insertRow(...)	Insert a new row into the target table. The new row is cloned from an adjacent row, so it inherits the existing cell shading, borders, alignment, and padding. No follow-up styling call is needed unless the new row should look different from the rest of the table.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.deleteRow	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.deleteRow(...)	Delete a row from the target table.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.setRowHeight	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.setRowHeight(...)	Set the height of a table row.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.distributeRows	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.distributeRows(...)	Distribute row heights evenly across the target table.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.setRowOptions	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.setRowOptions(...)	Set options on a table row such as header repeat or page break.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.insertColumn	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.insertColumn(...)	Insert a new column into the target table. The new column is cloned from an adjacent column, so it inherits the existing cell shading, borders, alignment, and width. No follow-up styling call is needed unless the new column should look different from the rest of the table.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.deleteColumn	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.deleteColumn(...)	Delete a column from the target table.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.setColumnWidth	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.setColumnWidth(...)	Set the width of a table column.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.distributeColumns	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.distributeColumns(...)	Distribute column widths evenly across the target table.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.insertCell	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.insertCell(...)	Insert a new cell into a table row.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.deleteCell	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.deleteCell(...)	Delete a cell from a table row.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.mergeCells	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.mergeCells(...)	Merge a range of table cells into one.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.unmergeCells	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.unmergeCells(...)	Unmerge a previously merged table cell.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.splitCell	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.splitCell(...)	Split a table cell into multiple cells.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.setCellProperties	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.setCellProperties(...)	Set non-text properties on a single table cell: vertical alignment, text wrapping, fit-text, or preferred width. Requires a cell-level target (a tableCell block address with kind, nodeType, nodeId). Does NOT accept a table target with rowIndex/columnIndex. To set the text content of a cell, use action "set_cell_text" instead.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.setCellText	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.setCellText(...)	Replace the text content of a single table cell with plain text (one paragraph). Accepts either a direct cell locator (a tableCell block address with kind, nodeType, nodeId) OR a table target with rowIndex + columnIndex. Cell properties (vertical alignment, shading, borders, colspan/rowspan) are preserved. Use this for filling cells with values, replacing cell text, or populating empty tables. Much simpler than walking paragraphs and runs through superdoc_edit.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.sort	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.sort(...)	Sort table rows by a column value.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.setAltText	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.setAltText(...)	Set the alternative text description for a table.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.setStyle	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.setStyle(...)	Apply a named table style to the target table.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.clearStyle	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.clearStyle(...)	Remove the applied table style, reverting to defaults.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.setStyleOption	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.setStyleOption(...)	Toggle a conditional style option such as banded rows or first column.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.setBorder	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.setBorder(...)	Set border properties on a table or cell range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.clearBorder	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.clearBorder(...)	Remove border formatting from a table or cell range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.applyBorderPreset	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.applyBorderPreset(...)	Apply a border preset (e.g. all borders, outside only) to a table.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.setShading	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.setShading(...)	Set the background shading color on a table or cell range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.clearShading	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.clearShading(...)	Remove shading from a table or cell range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.setTablePadding	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.setTablePadding(...)	Set default cell padding for the entire table.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.setCellPadding	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.setCellPadding(...)	Set padding on a specific table cell or cell range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.setCellSpacing	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.setCellSpacing(...)	Set the cell spacing for the target table.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.clearCellSpacing	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.clearCellSpacing(...)	Remove custom cell spacing from the target table.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.applyStyle	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.applyStyle(...)	Toggle conditional-format flags (header row, banded rows/columns, first/last column, last row) on a table. Pass styleOptions with the flags you want to set or clear (omitted flags stay unchanged). For "format the first row as a header" use styleOptions: { headerRow: true }. Optional styleId applies a named table style. Leave it unset unless you have a styleId from superdoc_get_content (no need to invent one).
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.setBorders	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.setBorders(...)	Set borders on a table using a target set or per-edge patch.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.setTableOptions	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.setTableOptions(...)	Set table-level default cell margins and/or cell spacing.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.applyPreset	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.applyPreset(...)	Apply a named visual preset to a table. Presets: "grid" (1pt black borders all around), "minimal" (no outer borders, hairline grey row separators + thicker bottom), "striped" (banded rows on, 0.5pt grey borders), "accent" (filled header row + thick accent top/bottom; defaults to dark blue, override with accentColor). Composes set_borders + set_style_options + header-row shading in one call. Available via the document API and superdoc_mutations (intentionally NOT exposed as a top-level action on superdoc_table. Agents should compose explicit set_borders / set_shading / set_style_options calls so they always pick concrete colors that match the document context).
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.get	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.get(...)	Retrieve table structure and dimensions by locator.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.getCells	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.getCells(...)	Retrieve cell information for a table, optionally filtered by row or column.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.getProperties	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.getProperties(...)	Retrieve layout and style properties of a table.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.getStyles	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.getStyles(...)	List all table styles and the document-level default table style setting.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.setDefaultStyle	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.setDefaultStyle(...)	Set the document-level default table style (w:defaultTableStyle in settings.xml).
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>tables.clearDefaultStyle	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.tables.clearDefaultStyle(...)	Remove the document-level default table style setting.

History

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>history.get	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.history.get(...)	Query the current undo/redo history state of the document.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>history.undo	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.history.undo(...)	Undo the most recent history-safe mutation in the document.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>history.redo	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.history.redo(...)	Redo the most recently undone action in the document.

Table of Contents

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>toc.list	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.toc.list(...)	List all tables of contents in the document.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>toc.get	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.toc.get(...)	Retrieve details of a specific table of contents.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>toc.configure	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.toc.configure(...)	Update the configuration switches of a table of contents.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>toc.update	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.toc.update(...)	Rebuild or refresh the materialized content of a table of contents.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>toc.remove	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.toc.remove(...)	Remove a table of contents from the document.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>toc.markEntry	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.toc.markEntry(...)	Insert a TC (table of contents entry) field at the target paragraph.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>toc.unmarkEntry	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.toc.unmarkEntry(...)	Remove a TC (table of contents entry) field from the document.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>toc.listEntries	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.toc.listEntries(...)	List all TC (table of contents entry) fields in the document body.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>toc.getEntry	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.toc.getEntry(...)	Retrieve details of a specific TC (table of contents entry) field.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>toc.editEntry	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.toc.editEntry(...)	Update the properties of a TC (table of contents entry) field.

Images

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>images.list	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.images.list(...)	List all images in the document.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>images.get	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.images.get(...)	Get details for a specific image by its stable ID.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>images.delete	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.images.delete(...)	Delete an image from the document.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>images.move	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.images.move(...)	Move an image to a new location in the document.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>images.convertToInline	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.images.convertToInline(...)	Convert a floating image to inline placement.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>images.convertToFloating	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.images.convertToFloating(...)	Convert an inline image to floating placement.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>images.setSize	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.images.setSize(...)	Set explicit width/height for an image.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>images.setWrapType	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.images.setWrapType(...)	Set the text wrapping type for a floating image.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>images.setWrapSide	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.images.setWrapSide(...)	Set which side(s) text wraps around a floating image.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>images.setWrapDistances	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.images.setWrapDistances(...)	Set the text-wrap distance margins for a floating image.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>images.setPosition	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.images.setPosition(...)	Set the anchor position for a floating image.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>images.setAnchorOptions	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.images.setAnchorOptions(...)	Set anchor behavior options for a floating image.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>images.setZOrder	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.images.setZOrder(...)	Set the z-order (relativeHeight) for a floating image.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>images.scale	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.images.scale(...)	Scale an image by a uniform factor applied to both dimensions.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>images.setLockAspectRatio	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.images.setLockAspectRatio(...)	Lock or unlock the aspect ratio for an image.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>images.rotate	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.images.rotate(...)	Set the absolute rotation angle for an image.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>images.flip	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.images.flip(...)	Set horizontal and/or vertical flip state for an image.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>images.crop	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.images.crop(...)	Apply rectangular edge-percentage crop to an image.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>images.resetCrop	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.images.resetCrop(...)	Remove all cropping from an image.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>images.replaceSource	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.images.replaceSource(...)	Replace the image source while preserving identity and placement.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>images.setAltText	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.images.setAltText(...)	Set the accessibility description (alt text) for an image.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>images.setDecorative	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.images.setDecorative(...)	Mark or unmark an image as decorative.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>images.setName	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.images.setName(...)	Set the object name for an image.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>images.setHyperlink	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.images.setHyperlink(...)	Set or remove the hyperlink attached to an image.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>images.insertCaption	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.images.insertCaption(...)	Insert a caption paragraph below the image.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>images.updateCaption	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.images.updateCaption(...)	Update the text of an existing caption paragraph.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>images.removeCaption	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.images.removeCaption(...)	Remove the caption paragraph from below the image.

Hyperlinks

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>hyperlinks.list	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.hyperlinks.list(...)	List all hyperlinks in the document, with optional filtering by href, anchor, or display text.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>hyperlinks.get	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.hyperlinks.get(...)	Retrieve details of a specific hyperlink by its inline address.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>hyperlinks.wrap	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.hyperlinks.wrap(...)	Wrap an existing text range with a hyperlink.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>hyperlinks.insert	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.hyperlinks.insert(...)	Insert new linked text at a target position.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>hyperlinks.patch	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.hyperlinks.patch(...)	Update hyperlink metadata (destination, tooltip, target, rel) without changing display text.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>hyperlinks.remove	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.hyperlinks.remove(...)	Remove a hyperlink. Mode 'unwrap' preserves display text; 'deleteText' removes the linked content entirely.

Headers & Footers

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>headerFooters.list	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.headerFooters.list(...)	List header/footer slot entries across sections.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>headerFooters.get	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.headerFooters.get(...)	Get a single header/footer slot entry by address.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>headerFooters.resolve	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.headerFooters.resolve(...)	Resolve the effective header/footer reference for a slot, walking the section inheritance chain.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>headerFooters.refs.set	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.headerFooters.refs.set(...)	Set an explicit header/footer reference on a section slot.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>headerFooters.refs.clear	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.headerFooters.refs.clear(...)	Clear an explicit header/footer reference from a section slot.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>headerFooters.refs.setLinkedToPrevious	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.headerFooters.refs.setLinkedToPrevious(...)	Link or unlink a header/footer slot to/from the previous section.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>headerFooters.parts.list	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.headerFooters.parts.list(...)	List unique header/footer part records from document relationships.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>headerFooters.parts.create	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.headerFooters.parts.create(...)	Create a new independent header/footer part, optionally cloned from an existing part.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>headerFooters.parts.delete	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.headerFooters.parts.delete(...)	Delete a header/footer part and its associated relationship when no section slots reference it.

Content Controls

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>create.contentControl	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.create.contentControl(...)	Create a new content control (SDT) in the document.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.list	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.list(...)	List all content controls in the document with optional type/tag filtering.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.get	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.get(...)	Retrieve a single content control by target.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.listInRange	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.listInRange(...)	List content controls within a block range.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.selectByTag	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.selectByTag(...)	Select content controls matching a specific tag value.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.selectByTitle	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.selectByTitle(...)	Select content controls matching a specific title (alias) value.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.listChildren	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.listChildren(...)	List direct child content controls nested inside the target.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.getParent	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.getParent(...)	Get the parent content control of the target, if any.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.wrap	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.wrap(...)	Wrap existing content with a new content control.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.unwrap	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.unwrap(...)	Remove the content control wrapper, preserving its content in place.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.delete	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.delete(...)	Delete a content control and its content from the document.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.copy	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.copy(...)	Copy a content control to a destination position. Copied SDTs receive new IDs.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.move	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.move(...)	Move a content control to a new position. Preserves original IDs.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.patch	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.patch(...)	Patch metadata properties on a content control (tag, alias, appearance, color, etc.).
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.setLockMode	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.setLockMode(...)	Set the lock mode on a content control.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.setType	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.setType(...)	Transition a content control to a different semantic type. Metadata-only; no implicit content rewrite.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.getContent	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.getContent(...)	Get the text content of a content control.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.replaceContent	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.replaceContent(...)	Replace the entire content of a content control.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.clearContent	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.clearContent(...)	Clear all content inside a content control, leaving it empty.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.appendContent	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.appendContent(...)	Append content to the end of a content control.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.prependContent	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.prependContent(...)	Prepend content to the beginning of a content control.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.insertBefore	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.insertBefore(...)	Insert content immediately before a content control.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.insertAfter	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.insertAfter(...)	Insert content immediately after a content control.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.getBinding	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.getBinding(...)	Get the data binding metadata (w:dataBinding) of a content control.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.setBinding	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.setBinding(...)	Set data binding metadata on a content control.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.clearBinding	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.clearBinding(...)	Remove data binding metadata from a content control.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.getRawProperties	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.getRawProperties(...)	Get the raw sdtPr properties of a content control as a passthrough hash.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.patchRawProperties	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.patchRawProperties(...)	Apply raw XML-level patches to the sdtPr subtree of a content control.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.validateWordCompatibility	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.validateWordCompatibility(...)	Validate a content control for Word compatibility issues.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.normalizeWordCompatibility	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.normalizeWordCompatibility(...)	Normalize a content control to resolve Word compatibility issues.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.normalizeTagPayload	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.normalizeTagPayload(...)	Normalize a content control tag between plain-string and JSON-encoded formats.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.text.setMultiline	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.text.setMultiline(...)	Set or clear the multiline attribute on a plain-text content control.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.text.setValue	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.text.setValue(...)	Set the text value of a plain-text content control.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.text.clearValue	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.text.clearValue(...)	Clear the text value of a plain-text content control.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.date.setValue	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.date.setValue(...)	Set the date value of a date content control.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.date.clearValue	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.date.clearValue(...)	Clear the date value of a date content control.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.date.setDisplayFormat	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.date.setDisplayFormat(...)	Set the display format string for a date content control.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.date.setDisplayLocale	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.date.setDisplayLocale(...)	Set the display locale for a date content control.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.date.setStorageFormat	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.date.setStorageFormat(...)	Set the XML storage format for a date content control.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.date.setCalendar	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.date.setCalendar(...)	Set the calendar type for a date content control.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.checkbox.getState	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.checkbox.getState(...)	Get the checked state of a checkbox content control.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.checkbox.setState	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.checkbox.setState(...)	Set the checked state of a checkbox content control.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.checkbox.toggle	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.checkbox.toggle(...)	Toggle the checked state of a checkbox content control.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.checkbox.setSymbolPair	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.checkbox.setSymbolPair(...)	Set the checked and unchecked symbol glyphs for a checkbox content control.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.choiceList.getItems	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.choiceList.getItems(...)	Get the list items and selected value of a comboBox or dropDownList content control.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.choiceList.setItems	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.choiceList.setItems(...)	Replace the list items of a comboBox or dropDownList content control.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.choiceList.setSelected	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.choiceList.setSelected(...)	Set the selected value of a comboBox or dropDownList content control.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.repeatingSection.listItems	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.repeatingSection.listItems(...)	List the repeating section items inside a repeating section content control.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.repeatingSection.insertItemBefore	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.repeatingSection.insertItemBefore(...)	Insert a new item before a specific index in a repeating section.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.repeatingSection.insertItemAfter	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.repeatingSection.insertItemAfter(...)	Insert a new item after a specific index in a repeating section.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.repeatingSection.cloneItem	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.repeatingSection.cloneItem(...)	Clone a repeating section item at the given index. Cloned SDTs receive new IDs.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.repeatingSection.deleteItem	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.repeatingSection.deleteItem(...)	Delete a repeating section item at the given index.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.repeatingSection.setAllowInsertDelete	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.repeatingSection.setAllowInsertDelete(...)	Set the allowInsertDelete flag on a repeating section.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.group.wrap	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.group.wrap(...)	Wrap a content control inside a new group content control. Always nests; not idempotent.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>contentControls.group.ungroup	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.contentControls.group.ungroup(...)	Remove the group designation from a group content control.

Bookmarks

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>bookmarks.list	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.bookmarks.list(...)	List all bookmarks in the document.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>bookmarks.get	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.bookmarks.get(...)	Get detailed information about a specific bookmark.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>bookmarks.insert	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.bookmarks.insert(...)	Insert a new named bookmark at a target location.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>bookmarks.rename	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.bookmarks.rename(...)	Rename an existing bookmark.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>bookmarks.remove	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.bookmarks.remove(...)	Remove a bookmark from the document.

Footnotes

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>footnotes.list	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.footnotes.list(...)	List all footnotes and endnotes in the document.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>footnotes.get	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.footnotes.get(...)	Get detailed information about a specific footnote or endnote.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>footnotes.insert	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.footnotes.insert(...)	Insert a new footnote or endnote at a target location.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>footnotes.update	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.footnotes.update(...)	Update the content of an existing footnote or endnote.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>footnotes.remove	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.footnotes.remove(...)	Remove a footnote or endnote from the document.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>footnotes.configure	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.footnotes.configure(...)	Configure numbering and placement for footnotes or endnotes.

Cross-References

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>crossRefs.list	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.crossRefs.list(...)	List all cross-reference fields in the document.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>crossRefs.get	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.crossRefs.get(...)	Get detailed information about a specific cross-reference field.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>crossRefs.insert	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.crossRefs.insert(...)	Insert a new cross-reference field at a target location.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>crossRefs.rebuild	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.crossRefs.rebuild(...)	Rebuild (recalculate) a cross-reference field.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>crossRefs.remove	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.crossRefs.remove(...)	Remove a cross-reference field from the document.

Index

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>index.list	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.index.list(...)	List all index blocks in the document.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>index.get	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.index.get(...)	Get detailed information about a specific index block.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>index.insert	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.index.insert(...)	Insert a new index block at a target location.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>index.configure	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.index.configure(...)	Update the configuration of an existing index block.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>index.rebuild	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.index.rebuild(...)	Rebuild (regenerate) an index block from its entries.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>index.remove	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.index.remove(...)	Remove an index block from the document.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>index.entries.list	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.index.entries.list(...)	List all XE (index entry) fields in the document.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>index.entries.get	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.index.entries.get(...)	Get detailed information about a specific XE index entry.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>index.entries.insert	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.index.entries.insert(...)	Insert a new XE index entry field at a target location.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>index.entries.update	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.index.entries.update(...)	Update the properties of an existing XE index entry.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>index.entries.remove	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.index.entries.remove(...)	Remove an XE index entry field from the document.

Captions

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>captions.list	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.captions.list(...)	List all caption paragraphs in the document.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>captions.get	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.captions.get(...)	Get detailed information about a specific caption paragraph.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>captions.insert	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.captions.insert(...)	Insert a new caption paragraph adjacent to a target block.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>captions.update	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.captions.update(...)	Update the text of an existing caption paragraph.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>captions.remove	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.captions.remove(...)	Remove a caption paragraph from the document.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>captions.configure	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.captions.configure(...)	Configure numbering format for a caption label.

Fields

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>fields.list	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.fields.list(...)	List all fields in the document.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>fields.get	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.fields.get(...)	Get detailed information about a specific field.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>fields.insert	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.fields.insert(...)	Insert a raw field code at a target location.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>fields.rebuild	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.fields.rebuild(...)	Rebuild (recalculate) a field.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>fields.remove	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.fields.remove(...)	Remove a field from the document.

Citations

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>citations.list	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.citations.list(...)	List all citation marks in the document.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>citations.get	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.citations.get(...)	Get detailed information about a specific citation mark.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>citations.insert	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.citations.insert(...)	Insert a new citation mark at a target location.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>citations.update	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.citations.update(...)	Update an existing citation mark's source references.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>citations.remove	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.citations.remove(...)	Remove a citation mark from the document.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>citations.sources.list	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.citations.sources.list(...)	List all citation sources in the document store.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>citations.sources.get	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.citations.sources.get(...)	Get detailed information about a specific citation source.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>citations.sources.insert	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.citations.sources.insert(...)	Register a new citation source in the document store.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>citations.sources.update	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.citations.sources.update(...)	Update the fields of an existing citation source.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>citations.sources.remove	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.citations.sources.remove(...)	Remove a citation source from the document store.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>citations.bibliography.get	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.citations.bibliography.get(...)	Get information about the bibliography block.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>citations.bibliography.insert	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.citations.bibliography.insert(...)	Insert a bibliography block at a target location.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>citations.bibliography.rebuild	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.citations.bibliography.rebuild(...)	Rebuild the bibliography from current sources.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>citations.bibliography.configure	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.citations.bibliography.configure(...)	Configure the bibliography style.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>citations.bibliography.remove	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.citations.bibliography.remove(...)	Remove the bibliography block from the document.

Table of Authorities

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>authorities.list	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.authorities.list(...)	List all table-of-authorities blocks in the document.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>authorities.get	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.authorities.get(...)	Get detailed information about a specific table-of-authorities block.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>authorities.insert	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.authorities.insert(...)	Insert a new table-of-authorities block at a target location.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>authorities.configure	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.authorities.configure(...)	Update the configuration of an existing table-of-authorities block.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>authorities.rebuild	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.authorities.rebuild(...)	Rebuild a table-of-authorities block from its entries.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>authorities.remove	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.authorities.remove(...)	Remove a table-of-authorities block from the document.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>authorities.entries.list	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.authorities.entries.list(...)	List all TA (authority entry) fields in the document.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>authorities.entries.get	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.authorities.entries.get(...)	Get detailed information about a specific TA authority entry.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>authorities.entries.insert	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.authorities.entries.insert(...)	Insert a new TA authority entry field at a target location.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>authorities.entries.update	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.authorities.entries.update(...)	Update the properties of an existing TA authority entry.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>authorities.entries.remove	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.authorities.entries.remove(...)	Remove a TA authority entry field from the document.

Ranges

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>ranges.resolve	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.ranges.resolve(...)	Resolve two explicit anchors into a contiguous document range. Returns a transparent SelectionTarget, a mutation-ready ref, and preview metadata. Stateless and deterministic.

Selection

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>selection.current	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.selection.current(...)	Read the editor's current selection as a portable SelectionInfo with a text-anchored TextTarget. Primitive for building custom comments UIs, floating toolbars, and other selection-driven components without reaching into ProseMirror internals.

Diff

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>diff.capture	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.diff.capture(...)	Capture the current document's diffable state as a versioned snapshot. v1 covers body, comments, styles, and numbering. Header/footer content is not included.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>diff.compare	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.diff.compare(...)	Compare the current document (base) against a previously captured target snapshot. Returns a versioned diff payload describing the changes from base to target.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>diff.apply	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.diff.apply(...)	Apply a previously computed diff payload to the current document. The document fingerprint must match the diff base fingerprint. Tracked mode governs body content only; styles, numbering, and comments are always applied directly.

Protection

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>protection.get	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.protection.get(...)	Read the current document protection state including editing restrictions, write protection, and read-only recommendation.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>protection.setEditingRestriction	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.protection.setEditingRestriction(...)	Enable Word-style editing restriction on the document. Only readOnly mode is supported in v1.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>protection.clearEditingRestriction	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.protection.clearEditingRestriction(...)	Disable document-level editing restriction by setting enforcement to off. Preserves the protection element and its metadata for round-trip fidelity.

Permission Ranges

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>permissionRanges.list	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.permissionRanges.list(...)	List all permission ranges in the document. Returns only complete paired ranges (both start and end markers present).
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>permissionRanges.get	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.permissionRanges.get(...)	Get detailed information about a specific permission range by ID.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>permissionRanges.create	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.permissionRanges.create(...)	Create a permission range exception region in the document. Inserts matched permStart/permEnd markers at the target.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>permissionRanges.remove	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.permissionRanges.remove(...)	Remove a permission range by ID. Removes whichever markers exist for the given ID (start, end, or both).
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>permissionRanges.updatePrincipal	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.permissionRanges.updatePrincipal(...)	Change which principal is allowed to edit a permission range. Updates the principal fields on the start marker.

Custom XML

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>customXml.parts.list	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.customXml.parts.list(...)	List Custom XML Data Storage Parts in the document, optionally filtered by root namespace or schema reference.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>customXml.parts.get	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.customXml.parts.get(...)	Get a single Custom XML Data Storage Part by itemID or package part name, including its full content. v1 partName targeting is limited to Word-style customXml/itemN.xml paths.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>customXml.parts.create	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.customXml.parts.create(...)	Add a new Custom XML Data Storage Part to the document. Generates a fresh itemID GUID and emits the Properties Part.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>customXml.parts.patch	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.customXml.parts.patch(...)	Replace the content and/or schemaRefs of an existing Custom XML Data Storage Part. At least one of content or schemaRefs is required. v1 partName targeting is limited to Word-style customXml/itemN.xml paths.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>customXml.parts.remove	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.customXml.parts.remove(...)	Remove a Custom XML Data Storage Part and clean up all linked package files (item, props, rels, content-types entry). v1 partName targeting is limited to Word-style customXml/itemN.xml paths.

Anchored Metadata

Operation	API member path	Description
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>metadata.attach	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.metadata.attach(...)	Anchor a JSON metadata payload to a span of text. Wraps the target range in a hidden inline content control whose w:tag carries a stable id, and stores the payload in a namespaced Custom XML Data Storage Part. v1 supports text-range anchors only.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>metadata.list	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.metadata.list(...)	List anchored-metadata entries in the document, optionally filtered by consumer namespace and/or a within selection (returns only entries whose anchor overlaps within).
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>metadata.get	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.metadata.get(...)	Get a single anchored-metadata entry by id, including its JSON payload.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>metadata.update	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.metadata.update(...)	Replace the JSON payload of an existing anchored-metadata entry. Replace semantics; no merge. The anchor is left untouched.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>metadata.remove	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.metadata.remove(...)	Remove an anchored-metadata entry. Strips the anchor content-control wrapper (its content stays in the document) and deletes the payload entry from the Storage Part. In v1 these writes are sequenced, not transactional: the adapter resolves the target up-front so missing-target failures land before any state change, but a crash strictly between the two writes can leave a dangling payload. When the backing part has no remaining entries, the part itself is removed.
<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>metadata.resolve	<span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}>editor.doc.metadata.resolve(...)	Find where an anchored-metadata entry is anchored in the document. Returns the SelectionTarget covering the anchor content.