Document apiReferenceStyles

styles.create

Define or redefine a named paragraph or character style in the Style Definitions part. Replaces the definition rather than merging into it, and decides conflicts on both styleId and name, because Word keys its Styles gallery on the name. Linked style pairs and table/numbering styles are out of scope.

mutates documentdry runconditional
doc.styles.create(…)

Expected result

Returns a StylesCreateReceipt reporting whether the style was created or redefined, with per-channel before/after state for the paragraph and run properties.

Inputs

paragraph
idstringrequired
namestringrequired
basedOnstring | null
aliasesstring[]
priorityinteger | null
qFormatboolean
hiddenboolean
semiHiddenboolean
unhideWhenUsedboolean
lockedboolean
customboolean
conflictPolicy"fail" | "replace"
type"paragraph"required
nextstring | null
paragraphobject
Fields
keepLinesboolean
keepNextboolean
widowControlboolean
contextualSpacingboolean
pageBreakBeforeboolean
suppressAutoHyphensboolean
suppressLineNumbersboolean
suppressOverlapboolean
mirrorIndentsboolean
wordWrapboolean
kinsokuboolean
overflowPunctboolean
topLinePunctboolean
autoSpaceDEboolean
autoSpaceDNboolean
adjustRightIndboolean
rightToLeftboolean
snapToGridboolean
outlineLvlinteger
justification"left" | "center" | "right" | "justify" | "distribute"
textAlignment"top" | "center" | "baseline" | "bottom" | "auto"
textDirection"lrTb" | "tbRl" | "btLr" | "lrTbV" | "tbRlV" | "tbLrV"
textboxTightWrap"none" | "allLines" | "firstAndLastLine" | "firstLineOnly" | "lastLineOnly"
spacingobject
Fields
afterinteger
afterAutospacingboolean
afterLinesinteger
beforeinteger
beforeAutospacingboolean
beforeLinesinteger
lineinteger
lineRule"auto" | "exact" | "atLeast"
indentobject
Fields
endinteger
endCharsinteger
firstLineinteger
firstLineCharsinteger
hanginginteger
hangingCharsinteger
leftinteger
leftCharsinteger
rightinteger
rightCharsinteger
startinteger
startCharsinteger
shadingobject
Fields
colorstring
fillstring
themeColorstring
themeFillstring
themeFillShadestring
themeFillTintstring
themeShadestring
themeTintstring
valstring
numberingPropertiesobject
Fields
ilvlinteger
numIdinteger
frameProbject
Fields
anchorLockboolean
dropCapstring
hinteger
hAnchorstring
hRulestring
hSpaceinteger
linesinteger
vAnchorstring
vSpaceinteger
winteger
wrapstring
xinteger
xAlignstring
yinteger
yAlignstring
bordersobject
Fields
topobject
bottomobject
leftobject
rightobject
betweenobject
barobject
tabStopsobject[]
runobject
Fields
boldboolean
boldCsboolean
italicboolean
iCsboolean
smallCapsboolean
strikeboolean
dstrikeboolean
embossboolean
imprintboolean
outlineboolean
shadowboolean
vanishboolean
webHiddenboolean
specVanishboolean
snapToGridboolean
noProofboolean
fontSizeinteger
fontSizeCsinteger
letterSpacinginteger
kerninteger
positioninteger
winteger
textTransform"uppercase" | "none"
vertAlign"superscript" | "subscript" | "baseline"
em"none" | "dot" | "comma" | "circle" | "sesame"
effectstring
fontFamilyobject
Fields
hintstring
asciistring
hAnsistring
eastAsiastring
csstring
valstring
asciiThemestring
hAnsiThemestring
eastAsiaThemestring
csthemestring
colorobject
Fields
valstring
themeColorstring
themeTintstring
themeShadestring
underlineobject
Fields
val"single" | "double" | "thick" | "dotted" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dotDash" | "dashDotHeavy" | "dotDotDash" | "dashDotDotHeavy" | "wave" | "wavyHeavy" | "wavyDouble" | "words" | "none"
colorstring
themeColorstring
themeTintstring
themeShadestring
bordersobject
Fields
valstring
colorstring
themeColorstring
themeTintstring
themeShadestring
sizeinteger
spaceinteger
shadowboolean
frameboolean
shadingobject
Fields
colorstring
fillstring
themeColorstring
themeFillstring
themeFillShadestring
themeFillTintstring
themeShadestring
themeTintstring
valstring
langobject
Fields
valstring
eastAsiastring
bidistring
eastAsianLayoutobject
Fields
idinteger
combineboolean
combineBracketsstring
vertboolean
vertCompressboolean
fitTextobject
Fields
valinteger
idinteger
csboolean
oMathboolean
rtlboolean
highlight"black" | "blue" | "cyan" | "green" | "magenta" | "red" | "yellow" | "white" | "darkBlue" | "darkCyan" | "darkGreen" | "darkMagenta" | "darkRed" | "darkYellow" | "darkGray" | "lightGray" | "none"
character
idstringrequired
namestringrequired
basedOnstring | null
aliasesstring[]
priorityinteger | null
qFormatboolean
hiddenboolean
semiHiddenboolean
unhideWhenUsedboolean
lockedboolean
customboolean
conflictPolicy"fail" | "replace"
type"character"required
runobject
Fields
boldboolean
boldCsboolean
italicboolean
iCsboolean
smallCapsboolean
strikeboolean
dstrikeboolean
embossboolean
imprintboolean
outlineboolean
shadowboolean
vanishboolean
webHiddenboolean
specVanishboolean
snapToGridboolean
noProofboolean
fontSizeinteger
fontSizeCsinteger
letterSpacinginteger
kerninteger
positioninteger
winteger
textTransform"uppercase" | "none"
vertAlign"superscript" | "subscript" | "baseline"
em"none" | "dot" | "comma" | "circle" | "sesame"
effectstring
fontFamilyobject
Fields
hintstring
asciistring
hAnsistring
eastAsiastring
csstring
valstring
asciiThemestring
hAnsiThemestring
eastAsiaThemestring
csthemestring
colorobject
Fields
valstring
themeColorstring
themeTintstring
themeShadestring
underlineobject
Fields
val"single" | "double" | "thick" | "dotted" | "dottedHeavy" | "dash" | "dashedHeavy" | "dashLong" | "dashLongHeavy" | "dotDash" | "dashDotHeavy" | "dotDotDash" | "dashDotDotHeavy" | "wave" | "wavyHeavy" | "wavyDouble" | "words" | "none"
colorstring
themeColorstring
themeTintstring
themeShadestring
bordersobject
Fields
valstring
colorstring
themeColorstring
themeTintstring
themeShadestring
sizeinteger
spaceinteger
shadowboolean
frameboolean
shadingobject
Fields
colorstring
fillstring
themeColorstring
themeFillstring
themeFillShadestring
themeFillTintstring
themeShadestring
themeTintstring
valstring
langobject
Fields
valstring
eastAsiastring
bidistring
eastAsianLayoutobject
Fields
idinteger
combineboolean
combineBracketsstring
vertboolean
vertCompressboolean
fitTextobject
Fields
valinteger
idinteger
csboolean
oMathboolean
rtlboolean
highlight"black" | "blue" | "cyan" | "green" | "magenta" | "red" | "yellow" | "white" | "darkBlue" | "darkCyan" | "darkGreen" | "darkMagenta" | "darkRed" | "darkYellow" | "darkGray" | "lightGray" | "none"

Result

Output fields
true
successtruerequired
changedbooleanrequired
createdbooleanrequired
resolutionobjectrequired
Fields
scope"style"required
idstringrequired
type"paragraph" | "character"required
xmlPartstringrequired
xmlPath"w:styles/w:style"required
dryRunbooleanrequired
beforeobject | nullrequired
paragraph
paragraphobject | nullrequired
Variant 1
keepLines"on" | "off" | "inherit"
keepNext"on" | "off" | "inherit"
widowControl"on" | "off" | "inherit"
contextualSpacing"on" | "off" | "inherit"
pageBreakBefore"on" | "off" | "inherit"
suppressAutoHyphens"on" | "off" | "inherit"
suppressLineNumbers"on" | "off" | "inherit"
suppressOverlap"on" | "off" | "inherit"
mirrorIndents"on" | "off" | "inherit"
wordWrap"on" | "off" | "inherit"
kinsoku"on" | "off" | "inherit"
overflowPunct"on" | "off" | "inherit"
topLinePunct"on" | "off" | "inherit"
autoSpaceDE"on" | "off" | "inherit"
autoSpaceDN"on" | "off" | "inherit"
adjustRightInd"on" | "off" | "inherit"
rightToLeft"on" | "off" | "inherit"
snapToGrid"on" | "off" | "inherit"
outlineLvlnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

justificationstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

textAlignmentstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

textDirectionstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

textboxTightWrapstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

spacingobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

indentobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

shadingobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

numberingPropertiesobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

frameProbject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

bordersobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

tabStopsunknown[] | "inherit"
Variant 1

No fields.

Variant 2

No fields.

Variant 2

No fields.

runobject | nullrequired
Variant 1
bold"on" | "off" | "inherit"
boldCs"on" | "off" | "inherit"
italic"on" | "off" | "inherit"
iCs"on" | "off" | "inherit"
smallCaps"on" | "off" | "inherit"
strike"on" | "off" | "inherit"
dstrike"on" | "off" | "inherit"
emboss"on" | "off" | "inherit"
imprint"on" | "off" | "inherit"
outline"on" | "off" | "inherit"
shadow"on" | "off" | "inherit"
vanish"on" | "off" | "inherit"
webHidden"on" | "off" | "inherit"
specVanish"on" | "off" | "inherit"
snapToGrid"on" | "off" | "inherit"
noProof"on" | "off" | "inherit"
fontSizenumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

fontSizeCsnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

letterSpacingnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

kernnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

positionnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

wnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

textTransformstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

vertAlignstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

emstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

effectstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

fontFamilyobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

colorobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

underlineobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

bordersobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

shadingobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

langobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

eastAsianLayoutobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

fitTextobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

cs"on" | "off" | "inherit"
oMath"on" | "off" | "inherit"
rtl"on" | "off" | "inherit"
highlightstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

Variant 2

No fields.

Variant 2

No fields.

afterobjectrequired
Fields
paragraphobject | nullrequired
Variant 1
keepLines"on" | "off" | "inherit"
keepNext"on" | "off" | "inherit"
widowControl"on" | "off" | "inherit"
contextualSpacing"on" | "off" | "inherit"
pageBreakBefore"on" | "off" | "inherit"
suppressAutoHyphens"on" | "off" | "inherit"
suppressLineNumbers"on" | "off" | "inherit"
suppressOverlap"on" | "off" | "inherit"
mirrorIndents"on" | "off" | "inherit"
wordWrap"on" | "off" | "inherit"
kinsoku"on" | "off" | "inherit"
overflowPunct"on" | "off" | "inherit"
topLinePunct"on" | "off" | "inherit"
autoSpaceDE"on" | "off" | "inherit"
autoSpaceDN"on" | "off" | "inherit"
adjustRightInd"on" | "off" | "inherit"
rightToLeft"on" | "off" | "inherit"
snapToGrid"on" | "off" | "inherit"
outlineLvlnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

justificationstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

textAlignmentstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

textDirectionstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

textboxTightWrapstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

spacingobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

indentobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

shadingobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

numberingPropertiesobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

frameProbject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

bordersobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

tabStopsunknown[] | "inherit"
Variant 1

No fields.

Variant 2

No fields.

Variant 2

No fields.

runobject | nullrequired
Variant 1
bold"on" | "off" | "inherit"
boldCs"on" | "off" | "inherit"
italic"on" | "off" | "inherit"
iCs"on" | "off" | "inherit"
smallCaps"on" | "off" | "inherit"
strike"on" | "off" | "inherit"
dstrike"on" | "off" | "inherit"
emboss"on" | "off" | "inherit"
imprint"on" | "off" | "inherit"
outline"on" | "off" | "inherit"
shadow"on" | "off" | "inherit"
vanish"on" | "off" | "inherit"
webHidden"on" | "off" | "inherit"
specVanish"on" | "off" | "inherit"
snapToGrid"on" | "off" | "inherit"
noProof"on" | "off" | "inherit"
fontSizenumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

fontSizeCsnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

letterSpacingnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

kernnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

positionnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

wnumber | "inherit"
Variant 1

No fields.

Variant 2

No fields.

textTransformstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

vertAlignstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

emstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

effectstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

fontFamilyobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

colorobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

underlineobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

bordersobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

shadingobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

langobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

eastAsianLayoutobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

fitTextobject | "inherit"
Variant 1

No fields.

Variant 2

No fields.

cs"on" | "off" | "inherit"
oMath"on" | "off" | "inherit"
rtl"on" | "off" | "inherit"
highlightstring | "inherit"
Variant 1

No fields.

Variant 2

No fields.

Variant 2

No fields.

false
successfalserequired
failureobjectrequired
Fields
code"DUPLICATE_ID" | "STYLE_CONFLICT" | "PRECONDITION_FAILED"required
messagestringrequired
detailsunknown

Failures

Pre-apply throws

  • INVALID_INPUT
  • CAPABILITY_UNAVAILABLE
  • REVISION_MISMATCH

Non-applied receipt codes

  • DUPLICATE_ID
  • STYLE_CONFLICT
  • PRECONDITION_FAILED

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