Word.BorderLocation enum

Package:

word

Remarks

[ API set: WordApi 1.3 ]

Examples

TypeScript

// 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 table in the document.
await Word.run(async (context) => {
  const firstTable: Word.Table = context.document.body.tables.getFirst();
  const borderLocation = Word.BorderLocation.top;
  const border: Word.TableBorder = firstTable.getBorder(borderLocation);
  border.load(["type", "color", "width"]);
  await context.sync();

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

Fields

all = "All"	[ API set: WordApi 1.3 ]
bottom = "Bottom"	[ API set: WordApi 1.3 ]
inside = "Inside"	[ API set: WordApi 1.3 ]
insideHorizontal = "InsideHorizontal"	[ API set: WordApi 1.3 ]
insideVertical = "InsideVertical"	[ API set: WordApi 1.3 ]
left = "Left"	[ API set: WordApi 1.3 ]
outside = "Outside"	[ API set: WordApi 1.3 ]
right = "Right"	[ API set: WordApi 1.3 ]
top = "Top"	[ API set: WordApi 1.3 ]