API member directory

Use this directory to find task examples and runtime limits for the public API. The generated API reference provides exact declarations, overloads, and enum values. The repository also publishes generated declarations for the root entry, the browser entry, and the agent entry.

A declaration or enum value does not guarantee runtime support for every document or argument. Read the linked guide before choosing an operation. Members marked @internal, including factories and hydration helpers, are not supported application APIs. Obtain model objects from context.document; do not construct them.

Runtime and common members

Agent helpers

The @docx-editor.dev/editor-api/agent entry holds helpers next to the object model. They are not Office.js members. They use only the Office.js-shaped calls of the object model on the context and paragraph that you pass in.

Document and text objects

Every model object inherits the common ClientObject members. Each collection also exposes loaded, read-only items.

Formatting, lists, tables, and pictures

Font writes honor inherited complex-script properties. Font reads return authored values or null; they do not resolve inherited formatting.

Fields, stories, and controls

Range.insertContentControl() creates RichText, PlainText, and DatePicker controls.

Range.insertBreak() supports Line, Page, and SectionNext. Only Line supports tracked insertion and text edits in the same sync. Text reads use \v for manual line breaks and U+000E for column breaks. For migration instructions, see Upgrade text processing.

Comments and revisions

Comment.delete() and CommentReply.delete() use scan budgets that scale with the loaded document. Deletions in one batch share marker scans and rebuild each affected part once. See Delete threads or replies for deletion guarantees and limits.

Document.changeTrackingMode = 'TrackMineOnly' tracks supported text, font, paragraph, list, table, and content control edits. Column changes require an eligible complete proposed table. Page setup refuses while tracking. For supported operations and collaboration limits, see Tracked changes.

Distinguish host extensions from Office.js compatibility

Host factories, runtime capabilities, previews, input budgets, and collaboration setup are DocxEditor infrastructure. They do not represent Microsoft Office add-in APIs. Review item ranges, body-scoped bookmarks and revisions, document notes, typed control values, and nullable review dates include documented differences.

External document refresh

The refresh controller belongs to the browser host, outside the Office.js document model. RefreshHighlightOptions controls change selection and decoration. NavigateToChangeOptions controls scroll alignment, motion, padding, and focus. For more information, see Document refresh API.

RefreshChangeInput.description supplies a processor review summary. RefreshChange.diagnostic reports unavailable locations with stable codes and the requested anchor. Refresh resets selection and undo history. It refuses collaborative sessions.

Document properties

Document.properties returns a DocumentProperties proxy. It exposes the string properties author, title, subject, keywords, comments, and category. Load each property before reading it. Assignments commit at context.sync(). Missing properties read as empty strings. An empty assignment clears that value.

Writes preserve unrelated document properties. Values must contain XML-safe text with at most 4096 UTF-16 code units. TrackMineOnly refuses these writes with NotSupported. Individual dates and custom properties are unsupported. lastAuthor reads cp:lastModifiedBy and has no setter.

await runtime.run(async (context) => {
  const properties = context.document.properties;
  properties.author = 'Public Records Office';
  properties.title = 'Release packet';
  properties.subject = 'Public information';
  properties.keywords = '';
  properties.comments = '';
  await context.sync();
});

Collaborative writes require an existing core-properties part. If the input omits this part, set properties before joining collaboration. Concurrent creation of this package part cannot merge safely.

Remove document properties

Call document.removeDocumentInformation('DocumentProperties') to remove standard core, extended, and custom property parts. Keep this command as the only write in its sync. This also removes last-author information and property relationships. It preserves document content, comments, revisions, and media.

Ambiguous parts, incorrect roots or types, and unknown dependencies refuse with NotSupported. The method refuses all other RemoveDocInfoType modes, tracked writes, and collaboration. This subset does not anonymize text, cached field results, images, or review authors.

await runtime.run(async (context) => {
  context.document.removeDocumentInformation('DocumentProperties');
  await context.sync();
});

Next steps

See Office.js compatibility before migrating Office.js code. The generated reference remains the declaration authority; runtime notes and tests establish supported behavior.

For integration patterns, see Connect an agent to a document.