Skip to main content

SetTableBorderLeft

Sets the border which will be displayed on the left of the current table.

Syntax​

expression.SetTableBorderLeft(type, size, space, color);

expression - A variable that represents an ApiTablePr class.

Parameters​

NameRequired/OptionalData typeDefaultDescription
typeRequiredBorderTypeThe left border style.
sizeRequiredpt_8The width of the current left border measured in eighths of a point.
spaceRequiredptThe spacing offset in the left part of the table measured in points used to place this border.
colorRequiredApiColorThe border color.

Returns​

boolean

Example​

Apply a border to the left side of a table in a document.

// How do I add a border along the left edge of a table in a document?

// Outline the left side of a table with a visible border line in a document.

let doc = Api.GetDocument();
let paragraph = doc.GetElement(0);
paragraph.AddText("We add the left 4 point black border:");
let tableStyle = doc.CreateStyle("CustomTableStyle", "table");
tableStyle.SetBasedOn(doc.GetStyle("Bordered"));
let tablePr = tableStyle.GetTablePr();
let table = Api.CreateTable(3, 3);
table.SetWidth("percent", 100);
tablePr.SetTableBorderLeft("single", 32, 0, Api.Color(51, 51, 51));
table.SetTableLook(true, true, true, true, false, false);
table.SetStyle(tableStyle);
doc.Push(table);