SetTableBorderTop

Sets the border which will be displayed at the top of the current table.

Inherited from ApiTablePr.SetTableBorderTop.

Syntax

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

expression - A variable that represents an ApiTable class.

Parameters

Name	Required/Optional	Data type	Default	Description
type	Required	BorderType		The top border style.
size	Required	pt_8		The width of the current top border measured in eighths of a point.
space	Required	pt		The spacing offset in the top part of the table measured in points used to place this border.
color	Required	ApiColor		The border color.

Returns

boolean

Example

Set a border along the top edge of a table in a document.

// How do I apply a thick border to the top edge of a table in a document?

// Distinguish the top of a table from surrounding content in a document.

let doc = Api.GetDocument();
let paragraph = doc.GetElement(0);
paragraph.AddText("We create a 3x3 table and add the top 4 point black border:");
let table = Api.CreateTable(3, 3);
table.SetWidth("percent", 100);
table.SetTableBorderTop("single", 32, 0, Api.Color(51, 51, 51));
table.SetTableBorderBottom("single", 4, 0, Api.Color(51, 51, 51));
table.SetTableBorderLeft("single", 4, 0, Api.Color(51, 51, 51));
table.SetTableBorderRight("single", 4, 0, Api.Color(51, 51, 51));
table.SetTableBorderInsideV("single", 4, 0, Api.Color(255, 111, 61));
table.SetTableBorderInsideH("single", 4, 0, Api.Color(255, 111, 61));
doc.Push(table);