Skip to main content

SetShd

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

Syntax​

expression.SetShd(shd);

expression - A variable that represents an ApiTableCellPr class.

Parameters​

NameRequired/OptionalData typeDefaultDescription
shdRequiredApiShdThe shading created with the Api.CreateShd method.

Returns​

boolean

Example​

Apply a background shading to all table cells using the table cell properties of a style 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(Api.CreateShd("clear", Api.HexColor('#FF6F3D')));
table.SetStyle(tableStyle);
doc.Push(table);