Editor Agents & automation Document API

909 Talk to an engineerBook a chat

Agents & automation Document API

Migrate from v1

Mental model Application data Query content Output projections Rich content Replace and delete Mutation plans Tracked changes Comments Receipts and errors

Format operations

ReferenceFormat

Format operations

Canonical formatting mutation with directive semantics ('on', 'off', 'clear').

This page

View as Markdown/md/document-api/reference/format.md

Use with AI

Open in ChatGPT Open in Claude All docs as one filellms-full.txt Document API referencellms-reference.txt

45 operations. Names, descriptions, and behavior flags come from the canonical contract.

Filter operations in this namespace

Operations

format.applyApply inline run-property patch changes to the target range with explicit set/clear semantics.mutatestracked format.bCsSet or clear the `bCs` inline run property on the target text range.mutates format.boldSet or clear the `bold` inline run property on the target text range.mutatestracked format.borderSet or clear the `border` inline run property on the target text range.mutates format.capsSet or clear the `caps` inline run property on the target text range.mutatestracked format.charScaleSet or clear the `charScale` inline run property on the target text range.mutates format.colorSet or clear the `color` inline run property on the target text range.mutatestracked format.contextualAlternatesSet or clear the `contextualAlternates` inline run property on the target text range.mutates format.csSet or clear the `cs` inline run property on the target text range.mutates format.dstrikeSet or clear the `dstrike` inline run property on the target text range.mutates format.eastAsianLayoutSet or clear the `eastAsianLayout` inline run property on the target text range.mutates format.emSet or clear the `em` inline run property on the target text range.mutates format.embossSet or clear the `emboss` inline run property on the target text range.mutates format.fitTextSet or clear the `fitText` inline run property on the target text range.mutates format.fontFamilySet or clear the `fontFamily` inline run property on the target text range.mutatestracked format.fontSizeSet or clear the `fontSize` inline run property on the target text range.mutatestracked format.fontSizeCsSet or clear the `fontSizeCs` inline run property on the target text range.mutates format.highlightSet or clear the `highlight` inline run property on the target text range.mutatestracked format.iCsSet or clear the `iCs` inline run property on the target text range.mutates format.imprintSet or clear the `imprint` inline run property on the target text range.mutates format.italicSet or clear the `italic` inline run property on the target text range.mutatestracked format.kerningSet or clear the `kerning` inline run property on the target text range.mutates format.langSet or clear the `lang` inline run property on the target text range.mutates format.letterSpacingSet or clear the `letterSpacing` inline run property on the target text range.mutatestracked format.ligaturesSet or clear the `ligatures` inline run property on the target text range.mutates format.numFormSet or clear the `numForm` inline run property on the target text range.mutates format.numSpacingSet or clear the `numSpacing` inline run property on the target text range.mutates format.oMathSet or clear the `oMath` inline run property on the target text range.mutates format.outlineSet or clear the `outline` inline run property on the target text range.mutates format.positionSet or clear the `position` inline run property on the target text range.mutatestracked format.rFontsSet or clear the `rFonts` inline run property on the target text range.mutates format.rStyleSet or clear the `rStyle` inline run property on the target text range.mutates format.rtlSet or clear the `rtl` inline run property on the target text range. This does not change paragraph direction; use `format.paragraph.setDirection` for paragraph-level RTL.mutates format.shadingSet or clear the `shading` inline run property on the target text range.mutates format.shadowSet or clear the `shadow` inline run property on the target text range.mutates format.smallCapsSet or clear the `smallCaps` inline run property on the target text range.mutates format.snapToGridSet or clear the `snapToGrid` inline run property on the target text range.mutates format.specVanishSet or clear the `specVanish` inline run property on the target text range.mutates format.strikeSet or clear the `strike` inline run property on the target text range.mutatestracked format.stylisticSetsSet or clear the `stylisticSets` inline run property on the target text range.mutates format.underlineSet or clear the `underline` inline run property on the target text range.mutatestracked format.vanishSet or clear the `vanish` inline run property on the target text range.mutates format.vertAlignSet or clear the `vertAlign` inline run property on the target text range.mutatestracked format.webHiddenSet or clear the `webHidden` inline run property on the target text range.mutates formatRangeLegacy root-level alias for inline range formatting. Routes to `format.apply` for compatibility with older callers.mutatestracked

Footnotes operations

Footnote and endnote lifecycle and numbering configuration.

Paragraph Formatting operations

Paragraph-level direct formatting: alignment, indentation, spacing, borders, shading, and more.