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 ApiTable class.
Parameters
Name | Required/Optional | Data type | Default | Description |
---|---|---|---|---|
sType | Required | BorderType | The border style. | |
nSize | Required | pt_8 | The width of the current border measured in eighths of a point. | |
nSpace | Required | pt | The spacing offset in the table cells measured in points used to place this border. | |
r | Required | byte | Red color component value. | |
g | Required | byte | Green color component value. | |
b | Required | byte | Blue color component value. |
Returns
boolean
Example
This example shows how to set a border for the entire table.
- Code
- Result
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);