Edit

Share via

Word.BuiltInStyleName enum

  • Reference
Package:
word

Represents the built-in style in a Word document.

Remarks

[ API set: WordApi 1.3 ]

Important: This enum was renamed from Style to BuiltInStyleName in WordApi 1.5.

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/insert-formatted-text.yaml

await Word.run(async (context) => {
  const sentence: Word.Paragraph = context.document.body.insertParagraph(
    "To be or not to be",
    "End"
  );

  // Use styleBuiltIn to use an enumeration of existing styles. If your style is custom make sure to use: range.style = "name of your style";
  sentence.styleBuiltIn = Word.BuiltInStyleName.intenseReference;

  await context.sync();
});

Fields

bibliography = "Bibliography"
bookTitle = "BookTitle"
caption = "Caption"
emphasis = "Emphasis"
endnoteReference = "EndnoteReference"
endnoteText = "EndnoteText"
footer = "Footer"
footnoteReference = "FootnoteReference"
footnoteText = "FootnoteText"
gridTable1Light = "GridTable1Light"
gridTable1Light_Accent1 = "GridTable1Light_Accent1"
gridTable1Light_Accent2 = "GridTable1Light_Accent2"
gridTable1Light_Accent3 = "GridTable1Light_Accent3"
gridTable1Light_Accent4 = "GridTable1Light_Accent4"
gridTable1Light_Accent5 = "GridTable1Light_Accent5"
gridTable1Light_Accent6 = "GridTable1Light_Accent6"
gridTable2 = "GridTable2"
gridTable2_Accent1 = "GridTable2_Accent1"
gridTable2_Accent2 = "GridTable2_Accent2"
gridTable2_Accent3 = "GridTable2_Accent3"
gridTable2_Accent4 = "GridTable2_Accent4"
gridTable2_Accent5 = "GridTable2_Accent5"
gridTable2_Accent6 = "GridTable2_Accent6"
gridTable3 = "GridTable3"
gridTable3_Accent1 = "GridTable3_Accent1"
gridTable3_Accent2 = "GridTable3_Accent2"
gridTable3_Accent3 = "GridTable3_Accent3"
gridTable3_Accent4 = "GridTable3_Accent4"
gridTable3_Accent5 = "GridTable3_Accent5"
gridTable3_Accent6 = "GridTable3_Accent6"
gridTable4 = "GridTable4"
gridTable4_Accent1 = "GridTable4_Accent1"
gridTable4_Accent2 = "GridTable4_Accent2"
gridTable4_Accent3 = "GridTable4_Accent3"
gridTable4_Accent4 = "GridTable4_Accent4"
gridTable4_Accent5 = "GridTable4_Accent5"
gridTable4_Accent6 = "GridTable4_Accent6"
gridTable5Dark = "GridTable5Dark"
gridTable5Dark_Accent1 = "GridTable5Dark_Accent1"
gridTable5Dark_Accent2 = "GridTable5Dark_Accent2"
gridTable5Dark_Accent3 = "GridTable5Dark_Accent3"
gridTable5Dark_Accent4 = "GridTable5Dark_Accent4"
gridTable5Dark_Accent5 = "GridTable5Dark_Accent5"
gridTable5Dark_Accent6 = "GridTable5Dark_Accent6"
gridTable6Colorful = "GridTable6Colorful"
gridTable6Colorful_Accent1 = "GridTable6Colorful_Accent1"
gridTable6Colorful_Accent2 = "GridTable6Colorful_Accent2"
gridTable6Colorful_Accent3 = "GridTable6Colorful_Accent3"
gridTable6Colorful_Accent4 = "GridTable6Colorful_Accent4"
gridTable6Colorful_Accent5 = "GridTable6Colorful_Accent5"
gridTable6Colorful_Accent6 = "GridTable6Colorful_Accent6"
gridTable7Colorful = "GridTable7Colorful"
gridTable7Colorful_Accent1 = "GridTable7Colorful_Accent1"
gridTable7Colorful_Accent2 = "GridTable7Colorful_Accent2"
gridTable7Colorful_Accent3 = "GridTable7Colorful_Accent3"
gridTable7Colorful_Accent4 = "GridTable7Colorful_Accent4"
gridTable7Colorful_Accent5 = "GridTable7Colorful_Accent5"
gridTable7Colorful_Accent6 = "GridTable7Colorful_Accent6"
header = "Header"
heading1 = "Heading1"
heading2 = "Heading2"
heading3 = "Heading3"
heading4 = "Heading4"
heading5 = "Heading5"
heading6 = "Heading6"
heading7 = "Heading7"
heading8 = "Heading8"
heading9 = "Heading9"
hyperlink = "Hyperlink"
intenseEmphasis = "IntenseEmphasis"
intenseQuote = "IntenseQuote"
intenseReference = "IntenseReference"
listParagraph = "ListParagraph"
listTable1Light = "ListTable1Light"
listTable1Light_Accent1 = "ListTable1Light_Accent1"
listTable1Light_Accent2 = "ListTable1Light_Accent2"
listTable1Light_Accent3 = "ListTable1Light_Accent3"
listTable1Light_Accent4 = "ListTable1Light_Accent4"
listTable1Light_Accent5 = "ListTable1Light_Accent5"
listTable1Light_Accent6 = "ListTable1Light_Accent6"
listTable2 = "ListTable2"
listTable2_Accent1 = "ListTable2_Accent1"
listTable2_Accent2 = "ListTable2_Accent2"
listTable2_Accent3 = "ListTable2_Accent3"
listTable2_Accent4 = "ListTable2_Accent4"
listTable2_Accent5 = "ListTable2_Accent5"
listTable2_Accent6 = "ListTable2_Accent6"
listTable3 = "ListTable3"
listTable3_Accent1 = "ListTable3_Accent1"
listTable3_Accent2 = "ListTable3_Accent2"
listTable3_Accent3 = "ListTable3_Accent3"
listTable3_Accent4 = "ListTable3_Accent4"
listTable3_Accent5 = "ListTable3_Accent5"
listTable3_Accent6 = "ListTable3_Accent6"
listTable4 = "ListTable4"
listTable4_Accent1 = "ListTable4_Accent1"
listTable4_Accent2 = "ListTable4_Accent2"
listTable4_Accent3 = "ListTable4_Accent3"
listTable4_Accent4 = "ListTable4_Accent4"
listTable4_Accent5 = "ListTable4_Accent5"
listTable4_Accent6 = "ListTable4_Accent6"
listTable5Dark = "ListTable5Dark"
listTable5Dark_Accent1 = "ListTable5Dark_Accent1"
listTable5Dark_Accent2 = "ListTable5Dark_Accent2"
listTable5Dark_Accent3 = "ListTable5Dark_Accent3"
listTable5Dark_Accent4 = "ListTable5Dark_Accent4"
listTable5Dark_Accent5 = "ListTable5Dark_Accent5"
listTable5Dark_Accent6 = "ListTable5Dark_Accent6"
listTable6Colorful = "ListTable6Colorful"
listTable6Colorful_Accent1 = "ListTable6Colorful_Accent1"
listTable6Colorful_Accent2 = "ListTable6Colorful_Accent2"
listTable6Colorful_Accent3 = "ListTable6Colorful_Accent3"
listTable6Colorful_Accent4 = "ListTable6Colorful_Accent4"
listTable6Colorful_Accent5 = "ListTable6Colorful_Accent5"
listTable6Colorful_Accent6 = "ListTable6Colorful_Accent6"
listTable7Colorful = "ListTable7Colorful"
listTable7Colorful_Accent1 = "ListTable7Colorful_Accent1"
listTable7Colorful_Accent2 = "ListTable7Colorful_Accent2"
listTable7Colorful_Accent3 = "ListTable7Colorful_Accent3"
listTable7Colorful_Accent4 = "ListTable7Colorful_Accent4"
listTable7Colorful_Accent5 = "ListTable7Colorful_Accent5"
listTable7Colorful_Accent6 = "ListTable7Colorful_Accent6"
normal = "Normal"

Reset character and paragraph style to default.
noSpacing = "NoSpacing"
other = "Other"

Mixed styles or other style not in this list.
plainTable1 = "PlainTable1"
plainTable2 = "PlainTable2"
plainTable3 = "PlainTable3"
plainTable4 = "PlainTable4"
plainTable5 = "PlainTable5"
quote = "Quote"
strong = "Strong"
subtitle = "Subtitle"
subtleEmphasis = "SubtleEmphasis"
subtleReference = "SubtleReference"
tableGrid = "TableGrid"
tableGridLight = "TableGridLight"
title = "Title"
toc1 = "Toc1"

Table-of-content level 1.
toc2 = "Toc2"

Table-of-content level 2.
toc3 = "Toc3"

Table-of-content level 3.
toc4 = "Toc4"

Table-of-content level 4.
toc5 = "Toc5"

Table-of-content level 5.
toc6 = "Toc6"

Table-of-content level 6.
toc7 = "Toc7"

Table-of-content level 7.
toc8 = "Toc8"

Table-of-content level 8.
toc9 = "Toc9"

Table-of-content level 9.
tocHeading = "TocHeading"

Table-of-content heading.