> ## Documentation Index
> Fetch the complete documentation index at: https://superdoc-caio-pizzol-docs-ai-core-preset.mintlify.site/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](../index)

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

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

## Convenience aliases

| Alias method                           | Canonical operation                                                                                                                                                       | Behavior                                                  |
| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
| `editor.doc.format.strikethrough(...)` | <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><a href="/document-api/reference/format/strike"><code>format.strike</code></a></span> | Convenience alias for `format.strike` with `value: true`. |