Skip to main content

SetShd

Specifies the shading applied to the contents of the table cell.

Syntax

expression.SetShd(sType, r, g, b, isAuto);

expression - A variable that represents a ApiTableCellPr class.

Parameters

NameRequired/OptionalData typeDefaultDescription
sTypeRequiredShdTypeThe shading type which will be applied to the contents of the current table cell.
rRequiredbyteRed color component value.
gRequiredbyteGreen color component value.
bRequiredbyteBlue color component value.
isAutoOptionalbooleanfalseThe true value disables the table cell contents shading.

Returns

boolean

Example

Apply a background color to a table cell in a document.

// How do I fill a table cell with a specific background color in a document?

// Highlight a table cell by giving it a colored background in a document.

let doc = Api.GetDocument();
let paragraph = doc.GetElement(0);
paragraph.AddText("We create a 3x3 table and add add an orange shading to all cells:");
let tableStyle = doc.CreateStyle("CustomTableStyle", "table");
tableStyle.SetBasedOn(doc.GetStyle("Bordered"));
let table = Api.CreateTable(3, 3);
table.SetWidth("percent", 100);
let tableCellPr = tableStyle.GetTableCellPr();
tableCellPr.SetShd("clear", Api.HexColor('#FF6F3D'));
table.SetStyle(tableStyle);
doc.Push(table);