Skip to main content

SetTableBorderRight

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

Inherited from ApiTablePr.SetTableBorderRight.

Syntax​

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

expression - A variable that represents an ApiTable class.

Parameters​

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

Returns​

boolean

Example​

Set a border along the right side of a table in a document.

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

// Distinguish the right side 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 right 4 point black border:");
let table = Api.CreateTable(3, 3);
table.SetWidth("percent", 100);
table.SetTableBorderTop("single", 4, 0, 51, 51, 51);
table.SetTableBorderBottom("single", 4, 0, 51, 51, 51);
table.SetTableBorderLeft("single", 4, 0, 51, 51, 51);
table.SetTableBorderRight("single", 32, 0, 51, 51, 51);
table.SetTableBorderInsideV("single", 4, 0, 255, 111, 61);
table.SetTableBorderInsideH("single", 4, 0, 255, 111, 61);
doc.Push(table);