Edit

Share via

Word.BorderType enum

  • Reference
Package:
word

Remarks

[ API set: WordApi 1.3 ]

Examples

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

// Gets border details about the first of the first table in the document.
await Word.run(async (context) => {
  const firstTable: Word.Table = context.document.body.tables.getFirst();
  const firstCell: Word.TableCell = firstTable.getCell(0, 0);
  const borderLocation = "Left";
  const border: Word.TableBorder = firstCell.getBorder(borderLocation);
  border.load(["type", "color", "width"]);
  await context.sync();

  console.log(`Details about the ${borderLocation} border of the first table's first cell:`, `- Color: ${border.color}`, `- Type: ${border.type}`, `- Width: ${border.width} points`);
});

Fields

dashDotStroked = "DashDotStroked"
dashed = "Dashed"
dashedSmall = "DashedSmall"
dot2Dashed = "Dot2Dashed"
dotDashed = "DotDashed"
dotted = "Dotted"
double = "Double"
doubleWave = "DoubleWave"
mixed = "Mixed"
none = "None"
single = "Single"
thickThinLarge = "ThickThinLarge"
thickThinMed = "ThickThinMed"
thickThinSmall = "ThickThinSmall"
thinThickLarge = "ThinThickLarge"
thinThickMed = "ThinThickMed"
thinThickSmall = "ThinThickSmall"
thinThickThinLarge = "ThinThickThinLarge"
thinThickThinMed = "ThinThickThinMed"
thinThickThinSmall = "ThinThickThinSmall"
threeDEmboss = "ThreeDEmboss"
threeDEngrave = "ThreeDEngrave"
triple = "Triple"
wave = "Wave"