Edit

Share via

Word.BorderWidth enum

  • Reference
Package:
word

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the width of a style's border.

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Examples

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

// Updates border properties (e.g., type, width, color) of the specified style.
await Word.run(async (context) => {
  const styleName = $("#style-name").val() as string;
  if (styleName == "") {
    console.warn("Enter a style name to update border properties.");
    return;
  }

  const style: Word.Style = context.document.getStyles().getByNameOrNullObject(styleName);
  style.load();
  await context.sync();

  if (style.isNullObject) {
    console.warn(`There's no existing style with the name '${styleName}'.`);
  } else {
    const borders: Word.BorderCollection = style.borders;
    borders.load("items");
    await context.sync();

    borders.outsideBorderType = Word.BorderType.dashed;
    borders.outsideBorderWidth = Word.BorderWidth.pt025;
    borders.outsideBorderColor = "green";
    console.log("Updated outside borders.");
  }
});

Fields

mixed = "Mixed"

Mixed width.
none = "None"

None width.
pt025 = "Pt025"

0.25 point.
pt050 = "Pt050"

0.50 point.
pt075 = "Pt075"

0.75 point.
pt100 = "Pt100"

1.00 point. This is the default.
pt150 = "Pt150"

1.50 points.
pt225 = "Pt225"

2.25 points.
pt300 = "Pt300"

3.00 points.
pt450 = "Pt450"

4.50 points.
pt600 = "Pt600"

6.00 points.