> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superdoc.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Format operations

> Format operation reference from the canonical Document API contract.

[Back to full reference](https://docs.superdoc.dev/document-api/reference/index.md)

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

| Operation | Member path | Mutates | Idempotency | Tracked | Dry run |
| - | - | - | - | - | - |
| [`formatRange`](https://docs.superdoc.dev/document-api/reference/format/apply) | `formatRange` | Yes | `conditional` | Yes | Yes |
| [`format.apply`](https://docs.superdoc.dev/document-api/reference/format/apply) | `format.apply` | Yes | `conditional` | Yes | Yes |
| [`format.bold`](https://docs.superdoc.dev/document-api/reference/format/bold) | `format.bold` | Yes | `conditional` | Yes | Yes |
| [`format.italic`](https://docs.superdoc.dev/document-api/reference/format/italic) | `format.italic` | Yes | `conditional` | Yes | Yes |
| [`format.strike`](https://docs.superdoc.dev/document-api/reference/format/strike) | `format.strike` | Yes | `conditional` | Yes | Yes |
| [`format.underline`](https://docs.superdoc.dev/document-api/reference/format/underline) | `format.underline` | Yes | `conditional` | Yes | Yes |
| [`format.highlight`](https://docs.superdoc.dev/document-api/reference/format/highlight) | `format.highlight` | Yes | `conditional` | Yes | Yes |
| [`format.color`](https://docs.superdoc.dev/document-api/reference/format/color) | `format.color` | Yes | `conditional` | Yes | Yes |
| [`format.fontSize`](https://docs.superdoc.dev/document-api/reference/format/font-size) | `format.fontSize` | Yes | `conditional` | Yes | Yes |
| [`format.fontFamily`](https://docs.superdoc.dev/document-api/reference/format/font-family) | `format.fontFamily` | Yes | `conditional` | Yes | Yes |
| [`format.letterSpacing`](https://docs.superdoc.dev/document-api/reference/format/letter-spacing) | `format.letterSpacing` | Yes | `conditional` | Yes | Yes |
| [`format.vertAlign`](https://docs.superdoc.dev/document-api/reference/format/vert-align) | `format.vertAlign` | Yes | `conditional` | Yes | Yes |
| [`format.position`](https://docs.superdoc.dev/document-api/reference/format/position) | `format.position` | Yes | `conditional` | Yes | Yes |
| [`format.dstrike`](https://docs.superdoc.dev/document-api/reference/format/dstrike) | `format.dstrike` | Yes | `conditional` | No | Yes |
| [`format.smallCaps`](https://docs.superdoc.dev/document-api/reference/format/small-caps) | `format.smallCaps` | Yes | `conditional` | No | Yes |
| [`format.caps`](https://docs.superdoc.dev/document-api/reference/format/caps) | `format.caps` | Yes | `conditional` | Yes | Yes |
| [`format.shading`](https://docs.superdoc.dev/document-api/reference/format/shading) | `format.shading` | Yes | `conditional` | No | Yes |
| [`format.border`](https://docs.superdoc.dev/document-api/reference/format/border) | `format.border` | Yes | `conditional` | No | Yes |
| [`format.outline`](https://docs.superdoc.dev/document-api/reference/format/outline) | `format.outline` | Yes | `conditional` | No | Yes |
| [`format.shadow`](https://docs.superdoc.dev/document-api/reference/format/shadow) | `format.shadow` | Yes | `conditional` | No | Yes |
| [`format.emboss`](https://docs.superdoc.dev/document-api/reference/format/emboss) | `format.emboss` | Yes | `conditional` | No | Yes |
| [`format.imprint`](https://docs.superdoc.dev/document-api/reference/format/imprint) | `format.imprint` | Yes | `conditional` | No | Yes |
| [`format.charScale`](https://docs.superdoc.dev/document-api/reference/format/char-scale) | `format.charScale` | Yes | `conditional` | No | Yes |
| [`format.kerning`](https://docs.superdoc.dev/document-api/reference/format/kerning) | `format.kerning` | Yes | `conditional` | No | Yes |
| [`format.vanish`](https://docs.superdoc.dev/document-api/reference/format/vanish) | `format.vanish` | Yes | `conditional` | No | Yes |
| [`format.webHidden`](https://docs.superdoc.dev/document-api/reference/format/web-hidden) | `format.webHidden` | Yes | `conditional` | No | Yes |
| [`format.specVanish`](https://docs.superdoc.dev/document-api/reference/format/spec-vanish) | `format.specVanish` | Yes | `conditional` | No | Yes |
| [`format.rtl`](https://docs.superdoc.dev/document-api/reference/format/rtl) | `format.rtl` | Yes | `conditional` | No | Yes |
| [`format.cs`](https://docs.superdoc.dev/document-api/reference/format/cs) | `format.cs` | Yes | `conditional` | No | Yes |
| [`format.bCs`](https://docs.superdoc.dev/document-api/reference/format/b-cs) | `format.bCs` | Yes | `conditional` | No | Yes |
| [`format.iCs`](https://docs.superdoc.dev/document-api/reference/format/i-cs) | `format.iCs` | Yes | `conditional` | No | Yes |
| [`format.eastAsianLayout`](https://docs.superdoc.dev/document-api/reference/format/east-asian-layout) | `format.eastAsianLayout` | Yes | `conditional` | No | Yes |
| [`format.em`](https://docs.superdoc.dev/document-api/reference/format/em) | `format.em` | Yes | `conditional` | No | Yes |
| [`format.fitText`](https://docs.superdoc.dev/document-api/reference/format/fit-text) | `format.fitText` | Yes | `conditional` | No | Yes |
| [`format.snapToGrid`](https://docs.superdoc.dev/document-api/reference/format/snap-to-grid) | `format.snapToGrid` | Yes | `conditional` | No | Yes |
| [`format.lang`](https://docs.superdoc.dev/document-api/reference/format/lang) | `format.lang` | Yes | `conditional` | No | Yes |
| [`format.oMath`](https://docs.superdoc.dev/document-api/reference/format/o-math) | `format.oMath` | Yes | `conditional` | No | Yes |
| [`format.rStyle`](https://docs.superdoc.dev/document-api/reference/format/r-style) | `format.rStyle` | Yes | `conditional` | No | Yes |
| [`format.rFonts`](https://docs.superdoc.dev/document-api/reference/format/r-fonts) | `format.rFonts` | Yes | `conditional` | No | Yes |
| [`format.fontSizeCs`](https://docs.superdoc.dev/document-api/reference/format/font-size-cs) | `format.fontSizeCs` | Yes | `conditional` | No | Yes |
| [`format.ligatures`](https://docs.superdoc.dev/document-api/reference/format/ligatures) | `format.ligatures` | Yes | `conditional` | No | Yes |
| [`format.numForm`](https://docs.superdoc.dev/document-api/reference/format/num-form) | `format.numForm` | Yes | `conditional` | No | Yes |
| [`format.numSpacing`](https://docs.superdoc.dev/document-api/reference/format/num-spacing) | `format.numSpacing` | Yes | `conditional` | No | Yes |
| [`format.stylisticSets`](https://docs.superdoc.dev/document-api/reference/format/stylistic-sets) | `format.stylisticSets` | Yes | `conditional` | No | Yes |
| [`format.contextualAlternates`](https://docs.superdoc.dev/document-api/reference/format/contextual-alternates) | `format.contextualAlternates` | Yes | `conditional` | No | Yes |

## Convenience aliases

| Alias method | Canonical operation | Behavior |
| - | - | - |
| `editor.doc.format.strikethrough(...)` | [`format.strike`](https://docs.superdoc.dev/document-api/reference/format/strike) | Convenience alias for `format.strike` with `value: true`. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.