Document API reference

Primary read and write operations.

Block-level structural operations.

Runtime support discovery for capability-aware branching.

Structured creation helpers.

Section structure and page-setup operations.

Canonical formatting mutation with directive semantics ('on', 'off', 'clear').

Document-level stylesheet mutations (docDefaults, style definitions).

List inspection and list mutations.

Comment authoring and thread lifecycle operations.

Tracked-change inspection and review operations.

Deterministic selector-based queries for mutation targeting.

Atomic mutation plan preview and execution.

Paragraph-level direct formatting: alignment, indentation, spacing, borders, shading, and more.

Paragraph style reference operations (set/clear w:pStyle).

Apply detected DOCX template/substrate (styles, numbering, settings, theme, font table, web settings, custom XML) from a source package onto the current document while preserving body content.

Table structure, layout, styling, and cell operations.

Undo/redo history state and navigation.

Table of contents lifecycle and configuration.

Image lifecycle, placement, and wrap configuration.

Hyperlink discovery, creation, and metadata management.

Structure, references, and part lifecycle for document headers and footers.

Content control (SDT) discovery, mutation, typed controls, and Word compatibility.

Named bookmark inspection, insertion, renaming, and removal.

Footnote and endnote lifecycle and numbering configuration.

Clipboard parsing, model insertion, and selection serialization.

Cross-reference field inspection, insertion, rebuild, and removal.

Index (TABLE OF AUTHORITIES / INDEX field) lifecycle and XE entry operations.

Caption (SEQ field) inspection, insertion, update, removal, and numbering configuration.

Raw field code inspection, insertion, rebuild, and removal.

Citation, source, and bibliography lifecycle operations.

Table of authorities lifecycle and TA entry operations.

Deterministic range construction from explicit document anchors.

Read the editor's current selection as a portable, addressable target.

Snapshot-based document comparison and replay.

Modeful DOCX export (review-preserving / final / original) with a structured degradation report.

Document-level protection state and editing restriction operations.

Permission range exception operations for protected documents.

Custom XML Data Storage Part operations (ECMA-376 §15.2.5, §15.2.6). Raw read and write of custom XML parts in the OOXML package.

Attach a JSON payload to a span of text and read it back across DOCX round-trips. Backed by hidden inline content controls and namespaced Custom XML Data Storage Parts; consumers see one operation set.