revisionAuthor | string | The name stamped on tracked changes and comments this writer makes. |
sessionStamp? | string | null | The document’s ReductoSession custom property as opened; null when it has none. |
suggesting | boolean | Tracked-change (“suggesting”) mode: edits become revisions instead of direct changes. |
allStyles()? | () => Promise<StyleListEntry[]> | The Styles pane’s “All styles” list. |
apply() | (selection: Selection, command: EditorCommand) => Promise<EditResult> | |
autoCorrected()? | () => boolean | The last command ended in an AutoFormat or AutoCorrect step, which Word’s Repeat cannot repeat. |
billedSession()? | () => Promise<string | null> | The Session the engine’s open joined and billed (s_<id>@<ISO start>); null when it bills nothing. |
bookmarks()? | () => EditorBookmark[] | Body bookmarks in document order, hidden ones included. |
canRedo() | () => boolean | |
canUndo() | () => boolean | |
captions()? | () => CaptionEntry[] | Body captions (SEQ-numbered paragraphs) in document order. |
characterStyles() | () => StyleChoice[] | Character styles a picker can offer, then Word’s Quick Styles the document lacks; apply with runFormat characterStyle. |
chartWorkbook()? | (selection: Selection) => Promise<ChartWorkbook | undefined> | The workbook of the chart the selection holds; undefined when it has none to open. |
citations()? | () => Promise<MarkedCitation[]> | Long citations TA fields mark, for Mark Citation’s list. |
comments() | () => ReviewComment[] | Body comments in document order, replies right after their root. |
compare()? | (revised: Uint8Array, options?: CompareOptions) => Promise<Uint8Array<ArrayBufferLike>> | Word’s Compare with this document as the original: revised with every difference tracked, as bytes. |
components()? | () => ComponentInfo[] | Custom components of the body in document order. |
contentControls() | () => ContentControlInfo[] | Body content controls in document order, an outer control before the ones it nests. |
fields()? | () => FieldSpan[] | Fields of the body and every story, for Word’s field shading. |
find() | (query: string, options?: { matchCase?: boolean }) => ReviewRange[] | Hits for query in the main story; replace one by selecting it and typing. |
formatAt() | (at: Position | Selection) => FormatState | Formatting at a caret, or over a selection: a toggle is on only when the whole range has it. |
headerFooters()? | () => HeaderFooterSlot[] | Each laid page’s header and footer, as of the last layout. |
layout() | () => Promise<LayoutDocument> | Current IR; lays out on first call and after every command. |
notes()? | () => NoteRef[] | Body footnote and endnote marks in document order. |
numberedItems()? | () => Promise<NumberedItem[]> | Numbered body paragraphs, for Insert Cross-reference’s “Numbered item”. |
ooxml() | (selection: Selection) => Promise<string> | The selection’s WML for the clipboard; a pkg:package when pictures or links travel with it. |
outline() | () => OutlineEntry[] | Body headings in document order, for a navigation pane. |
paragraphStyles() | () => StyleChoice[] | Paragraph styles a picker can offer, the default first, then Word’s Quick Styles the document lacks (builtin). |
revisions() | () => ReviewRevision[] | Body tracked changes in document order. |
styleDefinition()? | (id: string) => Promise<StyleDefinitionState | undefined> | Modify Style’s starting values: the style’s own properties. |
tableStyles() | () => StyleChoice[] | Table styles a picker can offer. |
targets() | (story?: string) => EditTarget[] | Every editable target in address order: the body, or one auxiliary story. |
text() | (target: EditTarget) => string | Plain text of one target, in the offset space positions use. |
toBytes() | (options?: SaveOptions) => Promise<Uint8Array<ArrayBufferLike>> | session is written as the ReductoSession custom property first. |