Format operations

Format operation reference from the canonical Document API contract.

Alpha: Document API is currently alpha and subject to breaking changes.

Back to full reference

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

Operation	Member path	Mutates	Idempotency	Tracked	Dry run
format.apply	format.apply	Yes	conditional	Yes	Yes
format.bold	format.bold	Yes	conditional	Yes	Yes
format.italic	format.italic	Yes	conditional	Yes	Yes
format.strike	format.strike	Yes	conditional	Yes	Yes
format.underline	format.underline	Yes	conditional	Yes	Yes
format.highlight	format.highlight	Yes	conditional	Yes	Yes
format.color	format.color	Yes	conditional	Yes	Yes
format.fontSize	format.fontSize	Yes	conditional	Yes	Yes
format.fontFamily	format.fontFamily	Yes	conditional	Yes	Yes
format.letterSpacing	format.letterSpacing	Yes	conditional	Yes	Yes
format.vertAlign	format.vertAlign	Yes	conditional	Yes	Yes
format.position	format.position	Yes	conditional	Yes	Yes
format.dstrike	format.dstrike	Yes	conditional	No	Yes
format.smallCaps	format.smallCaps	Yes	conditional	No	Yes
format.caps	format.caps	Yes	conditional	No	Yes
format.shading	format.shading	Yes	conditional	No	Yes
format.border	format.border	Yes	conditional	No	Yes
format.outline	format.outline	Yes	conditional	No	Yes
format.shadow	format.shadow	Yes	conditional	No	Yes
format.emboss	format.emboss	Yes	conditional	No	Yes
format.imprint	format.imprint	Yes	conditional	No	Yes
format.charScale	format.charScale	Yes	conditional	No	Yes
format.kerning	format.kerning	Yes	conditional	No	Yes
format.vanish	format.vanish	Yes	conditional	No	Yes
format.webHidden	format.webHidden	Yes	conditional	No	Yes
format.specVanish	format.specVanish	Yes	conditional	No	Yes
format.rtl	format.rtl	Yes	conditional	No	Yes
format.cs	format.cs	Yes	conditional	No	Yes
format.bCs	format.bCs	Yes	conditional	No	Yes
format.iCs	format.iCs	Yes	conditional	No	Yes
format.eastAsianLayout	format.eastAsianLayout	Yes	conditional	No	Yes
format.em	format.em	Yes	conditional	No	Yes
format.fitText	format.fitText	Yes	conditional	No	Yes
format.snapToGrid	format.snapToGrid	Yes	conditional	No	Yes
format.lang	format.lang	Yes	conditional	No	Yes
format.oMath	format.oMath	Yes	conditional	No	Yes
format.rStyle	format.rStyle	Yes	conditional	No	Yes
format.rFonts	format.rFonts	Yes	conditional	No	Yes
format.fontSizeCs	format.fontSizeCs	Yes	conditional	No	Yes
format.ligatures	format.ligatures	Yes	conditional	No	Yes
format.numForm	format.numForm	Yes	conditional	No	Yes
format.numSpacing	format.numSpacing	Yes	conditional	No	Yes
format.stylisticSets	format.stylisticSets	Yes	conditional	No	Yes
format.contextualAlternates	format.contextualAlternates	Yes	conditional	No	Yes

Convenience aliases

Alias method	Canonical operation	Behavior
editor.doc.format.strikethrough(...)	format.strike	Convenience alias for format.strike with value: true.