Skip to main content

SetTableBorderAll

Specifies a border which will be displayed on all table cell borders.

Syntax​

expression.SetTableBorderAll(sType, nSize, nSpace, r, g, b);

expression - A variable that represents a ApiTablePr class.

Parameters​

NameRequired/OptionalData typeDefaultDescription
sTypeRequiredBorderTypeThe border style.
nSizeRequiredpt_8The width of the current border measured in eighths of a point.
nSpaceRequiredptThe spacing offset in the table cells measured in points used to place this border.
rRequiredbyteRed color component value.
gRequiredbyteGreen color component value.
bRequiredbyteBlue color component value.

Returns​

boolean

Example​

Apply a uniform border around and inside every edge of a table in a document.

// How do I add borders to all sides of every cell in a table in a document?

// Draw consistent lines along all internal and external table edges in a document.

const doc = Api.GetDocument();
const paragraph = doc.GetElement(0);
paragraph.AddText("We create a 3x3 table and add 4 point black border for the entrire table:");
const tableStyle = doc.CreateStyle("CustomTableStyle", "table");
tableStyle.SetBasedOn(doc.GetStyle("Bordered"));
const tablePr = tableStyle.GetTablePr();
const table = Api.CreateTable(3, 3);
table.SetWidth("percent", 100);
tablePr.SetTableBorderAll("single", 32, 0, 51, 51, 51);
table.SetTableLook(true, true, true, true, false, false);
table.SetStyle(tableStyle);
doc.Push(table);