SetColumnBackgroundColor
Sets the background color to all cells in the column containing the current cell.
Syntax
expression.SetColumnBackgroundColor(color);
expression - A variable that represents an ApiTableCell class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| color | Optional | ApiColor | If not passed, the background color will be cleared. |
Returns
boolean
Example
Set the background color for an entire table column in a PDF.
// Color the background of a whole column via one of its cells in a PDF.
// Set an orange background for the entire first column in a PDF.
const doc = Api.GetDocument();
const page = doc.GetPage(0);
const table = Api.CreateTable(3, 4);
const cell = table.GetRow(0).GetCell(0);
cell.SetColumnBackgroundColor(Api.RGB(255, 111, 61));
page.AddObject(table);