Word.BorderWidth enum

Remarks

API set: WordApiDesktop 1.1

Used by

• Word.Border: width
• Word.BorderCollection: insideBorderWidth, outsideBorderWidth

Examples

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

// Updates border properties (e.g., type, width, color) of the specified style.
await Word.run(async (context) => {
 const styleName = (document.getElementById("style-name") as HTMLInputElement).value;
 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