Edit documents programmatically
Document Authoring provides a programmatic API for reading and updating document content with DocAuthDocument.transaction(). Transactions are atomic and isolated until committed. Each transaction gives you access to a draft document you can inspect or modify.
Before you start, make sure the Document Authoring library is installed and running in your app. If you haven’t set it up yet, refer to the getting started guide.
The examples omit error handling. Add it before you use this code in production.
Run a transaction
Use DocAuthDocument.transaction() to work with a draft document. Return true to commit the transaction:
// Assuming the `editor` instance exists.
const currentDoc = editor.currentDocument();
await currentDoc.transaction(async ({ draft }) => { const paragraph = draft.body().content().addParagraph();
paragraph.asTextView().setText('Created in a transaction.');
return true;});Choose an editing operation
Run every programmatic edit inside a transaction. Use these guides for specific editing tasks:
- Text and formatting — Set text, character formatting, and paragraph styles.
- Find and replace — Search and replace with strings, regular expressions, or callbacks.
- Lists — Create, update, and read bullet and numbered lists.
- Tables — Build tables and add or remove rows and columns.
- Images and shapes — Resize images and restyle shapes.
- Sections and page setup — Set page size, page margins, and header/footer distances.
- Headers and footers — Edit existing header and footer containers for each section.
- Footnotes and endnotes — Read and edit note content.
- Copy/paste and HTML interoperability — Read the selection and insert content, including structured fragments.
- Programmatic comments — Query, create, and resolve comment threads and author tracked-change edits.