CustomProperty
One user-defined property in docProps/custom.xml.
Import from @reductoai/docx/node, @reductoai/docx/officejs.
CustomProperty properties
CustomProperty.delete()
CustomProperty.set()
CustomPropertyCollection
The document’s user-defined properties; keys are matched case-insensitively.
Import from @reductoai/docx/node, @reductoai/docx/officejs.
CustomPropertyCollection properties
CustomPropertyCollection.add()
CustomPropertyCollection.at()
CustomPropertyCollection.deleteAll()
CustomPropertyCollection.getCount()
items.length; synchronous like the rest of OfficeJS here.
CustomPropertyCollection.getFirst()
CustomPropertyCollection.getFirstOrNullObject()
isNullObject before other members.
CustomPropertyCollection.getItem()
CustomPropertyCollection.getItemOrNullObject()
isNullObject before other members.
CustomPropertyCollection.getLast()
CustomPropertyCollection.getLastOrNullObject()
isNullObject before other members.
DocserverError
A failure of the live session. traceId finds the server’s log lines for it: the failed
request’s, or the connection’s for an error on the socket. code: "version": the editor and
the server are too far apart; the session stops instead of reloading. The message says which to update.
Import from @reductoai/docx-editor.
DocserverError properties
DocserverError.captureStackTrace()
.stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames
above constructorOpt, including constructorOpt, will be omitted from the
generated stack trace.
The constructorOpt argument is useful for hiding implementation
details of error generation from the user. For instance:
DocserverError.prepareStackTrace()
DocumentDefaults
Extension (Word’s “Set As Default”, VBA Font.SetAsTemplateDefault): the
document’s w:docDefaults, the bottom layer every style and table style
inherits. Reads are what a paragraph with no style properties shows.
Import from @reductoai/docx/officejs.
DocumentDefaults properties
DocumentLayout
Explicit headless extension; geometry is intentionally not presented as an OfficeJS member.
Import from @reductoai/docx/node, @reductoai/docx/officejs.
DocumentLayout.getOverlaps()
inHeaderFooter; a header range collides against every story
on the page, body text included.
DocumentLayout.getRects()
basis: "line").
A blank paragraph reports its laid line box (zero width, real y and
height), so empty spacers are still addressable geometry. A Table,
TableRow, or TableCell resolves to its laid grid box per page
(basis: "cellBox") — the box the borders paint on, not the text ink;
measure text via getRange(“Whole”). A Section resolves to its per-page
text-area box (basis: "textArea"), whose bottom edge is the true
vertical budget. A paragraph that stops short of that edge with clean
properties usually carries a run-level page break — read
Paragraph.hasPageBreak, because page breaks never show in text.
A footnote-story range resolves on its reference’s page (the note area);
endnote stories carry no laid provenance yet and refuse by name.
DocumentProperties
Import from @reductoai/docx/node, @reductoai/docx/officejs.