Skip to main content

SetShd

Specifies the shading applied to the contents of the current text run.

Syntax​

expression.SetShd(type, color);

expression - A variable that represents an ApiTextPr class.

Parameters​

NameRequired/OptionalData typeDefaultDescription
typeRequiredShdTypeThe shading type applied to the contents of the current text run.
colorRequiredApiColorThe color or pattern used to fill the shading.

Returns​

ApiTextPr

Example​

Apply a background shading color behind text in a document.

// How do I fill the background of a word or phrase with a color in a document?

// Highlight content by coloring the area directly behind the characters in a document.

let doc = Api.GetDocument();
let textPr = doc.GetDefaultTextPr();
textPr.SetShd('clear', Api.HexColor('#ff6f3d'));
let paragraph = doc.GetElement(0);
paragraph.AddText("A sample text with the shading set to orange.");