Word.StyleType enum

Remarks

API set: WordApi 1.5

Used by

• Word.Document: addStyle
• Word.DocumentCreated: addStyle
• Word.Style: type

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/28-formatting/manage-styles.yaml

// Applies the specified style to a paragraph.
await Word.run(async (context) => {
  const styleName = (document.getElementById("style-name-to-use") as HTMLInputElement).value;
  if (styleName == "") {
    console.warn("Enter a style name to apply.");
    return;
  }

  const style: Word.Style = context.document.getStyles().getByNameOrNullObject(styleName);
  style.load("isNullObject, nameLocal, type");
  await context.sync();

  if (style.isNullObject) {
    console.warn(`There's no existing style with the name '${styleName}'.`);
  } else if (style.type != Word.StyleType.paragraph) {
    console.log(`The '${styleName}' style isn't a paragraph style.`);
  } else {
    const body: Word.Body = context.document.body;
    body.clear();
    const paragraph: Word.Paragraph = body.insertParagraph(
      "This paragraph uses a custom style.",
      Word.InsertLocation.start
    );
    paragraph.style = style.nameLocal;
    await context.sync();

    console.log(`Applied '${styleName}' to the sample paragraph.`);
  }
});

Fields