tables.applyPreset
Apply a named table style preset to a table. Word presets (IDs starting with "word.", such as "word.grid-table-4-accent-1") install the built-in Word table style definition into the document when needed and reference it from the table, so the result opens in Word as that named style and follows the document theme. Call tables.listPresets first to get valid preset IDs. Use the "-accent-N" variants for theme accent colors; accentColor is rejected for Word presets. Optional styleOptions set the header row, last row, first column, last column, banded rows, and banded columns flags; omitted flags keep the table's current settings. Word presets remove table-level borders and shading so the style governs them; direct cell or run formatting is preserved and can override the style. In real-time collaboration every client receives the style definition and the table change together. Word presets are direct edits only: tracked mode returns CAPABILITY_UNAVAILABLE. SuperDoc convenience presets "grid", "minimal", "striped", and "accent" keep their existing behavior: they write direct borders, banding, and header shading (accentColor overrides the "accent" color). Use tables.applyStyle instead to reference a style ID that already exists in the document (see tables.getStyles).
doc.tables.applyPreset(…)Expected result
Returns a TableMutationResult receipt. Read tables.getProperties to see the installed Word style ID, which can differ from the Word default when the document already customizes that style.
Inputs
targetTableAddressconditionally requiredFields
kind"block"requirednodeType"table"requirednodeIdstringrequirednodeIdstringconditionally requiredpreset"word.table-grid" | "word.grid-table-light" | "word.plain-table-1" | "word.plain-table-2" | "word.plain-table-3" | "word.plain-table-4" | "word.plain-table-5" | "word.grid-table-1-light" | "word.grid-table-1-light-accent-1" | "word.grid-table-1-light-accent-2" | "word.grid-table-1-light-accent-3" | "word.grid-table-1-light-accent-4" | "word.grid-table-1-light-accent-5" | "word.grid-table-1-light-accent-6" | "word.grid-table-2" | "word.grid-table-2-accent-1" | "word.grid-table-2-accent-2" | "word.grid-table-2-accent-3" | "word.grid-table-2-accent-4" | "word.grid-table-2-accent-5" | "word.grid-table-2-accent-6" | "word.grid-table-3" | "word.grid-table-3-accent-1" | "word.grid-table-3-accent-2" | "word.grid-table-3-accent-3" | "word.grid-table-3-accent-4" | "word.grid-table-3-accent-5" | "word.grid-table-3-accent-6" | "word.grid-table-4" | "word.grid-table-4-accent-1" | "word.grid-table-4-accent-2" | "word.grid-table-4-accent-3" | "word.grid-table-4-accent-4" | "word.grid-table-4-accent-5" | "word.grid-table-4-accent-6" | "word.grid-table-5-dark" | "word.grid-table-5-dark-accent-1" | "word.grid-table-5-dark-accent-2" | "word.grid-table-5-dark-accent-3" | "word.grid-table-5-dark-accent-4" | "word.grid-table-5-dark-accent-5" | "word.grid-table-5-dark-accent-6" | "word.grid-table-6-colorful" | "word.grid-table-6-colorful-accent-1" | "word.grid-table-6-colorful-accent-2" | "word.grid-table-6-colorful-accent-3" | "word.grid-table-6-colorful-accent-4" | "word.grid-table-6-colorful-accent-5" | "word.grid-table-6-colorful-accent-6" | "word.grid-table-7-colorful" | "word.grid-table-7-colorful-accent-1" | "word.grid-table-7-colorful-accent-2" | "word.grid-table-7-colorful-accent-3" | "word.grid-table-7-colorful-accent-4" | "word.grid-table-7-colorful-accent-5" | "word.grid-table-7-colorful-accent-6" | "word.list-table-1-light" | "word.list-table-1-light-accent-1" | "word.list-table-1-light-accent-2" | "word.list-table-1-light-accent-3" | "word.list-table-1-light-accent-4" | "word.list-table-1-light-accent-5" | "word.list-table-1-light-accent-6" | "word.list-table-2" | "word.list-table-2-accent-1" | "word.list-table-2-accent-2" | "word.list-table-2-accent-3" | "word.list-table-2-accent-4" | "word.list-table-2-accent-5" | "word.list-table-2-accent-6" | "word.list-table-3" | "word.list-table-3-accent-1" | "word.list-table-3-accent-2" | "word.list-table-3-accent-3" | "word.list-table-3-accent-4" | "word.list-table-3-accent-5" | "word.list-table-3-accent-6" | "word.list-table-4" | "word.list-table-4-accent-1" | "word.list-table-4-accent-2" | "word.list-table-4-accent-3" | "word.list-table-4-accent-4" | "word.list-table-4-accent-5" | "word.list-table-4-accent-6" | "word.list-table-5-dark" | "word.list-table-5-dark-accent-1" | "word.list-table-5-dark-accent-2" | "word.list-table-5-dark-accent-3" | "word.list-table-5-dark-accent-4" | "word.list-table-5-dark-accent-5" | "word.list-table-5-dark-accent-6" | "word.list-table-6-colorful" | "word.list-table-6-colorful-accent-1" | "word.list-table-6-colorful-accent-2" | "word.list-table-6-colorful-accent-3" | "word.list-table-6-colorful-accent-4" | "word.list-table-6-colorful-accent-5" | "word.list-table-6-colorful-accent-6" | "word.list-table-7-colorful" | "word.list-table-7-colorful-accent-1" | "word.list-table-7-colorful-accent-2" | "word.list-table-7-colorful-accent-3" | "word.list-table-7-colorful-accent-4" | "word.list-table-7-colorful-accent-5" | "word.list-table-7-colorful-accent-6" | "grid" | "minimal" | "striped" | "accent"requiredPreset ID from tables.listPresets, for example "word.grid-table-4-accent-1" or "striped".
2 additional input fields
accentColorstringstyleOptionsobjectFields
headerRowbooleanlastRowbooleantotalRowbooleanfirstColumnbooleanlastColumnbooleanbandedRowsbooleanbandedColumnsbooleanResult
Output fields
true
successtruerequiredappliedChangeMode"direct" | "tracked"tableTableAddressFields
kind"block"requirednodeType"table"requirednodeIdstringrequiredtrackedChangeRefsEntityAddress[]false
successfalserequiredfailureobjectrequiredFields
code"NO_OP" | "INVALID_TARGET" | "TARGET_NOT_FOUND" | "CAPABILITY_UNAVAILABLE"requiredmessagestringrequireddetailsunknownFailures
Pre-apply throws
TARGET_NOT_FOUNDINVALID_TARGETCAPABILITY_UNAVAILABLE
1 more codes
INVALID_INPUT
Non-applied receipt codes
INVALID_TARGETINVALID_INPUTCAPABILITY_UNAVAILABLE
1 more codes
PRECONDITION_FAILED
Remediation guidance
- Call tables.listPresets to find a valid preset ID before applying one.
Raw schemas
Open the generated JSON artifact for the exact input, output, success, and failure schemas represented by this contract version.
View raw JSON schemas