Skip to main content

SetOpacity

Sets the opacity of the watermark in the document.

Syntax

expression.SetOpacity(nOpacity);

expression - A variable that represents a ApiWatermarkSettings class.

Parameters

NameRequired/OptionalData typeDefaultDescription
nOpacityRequirednumberThe watermark opacity. This value must be from 0 to 255.

Returns

This method doesn't return any data.

Example

This example sets the parameters of the watermark settings and apply them to the document.

let doc = Api.GetDocument();
let watermarkSettings = doc.GetWatermarkSettings();
watermarkSettings.SetType("text");
watermarkSettings.SetText("Example");
let textPr = watermarkSettings.GetTextPr();
textPr.SetFontFamily("Calibri");
textPr.SetFontSize(-1);
textPr.SetDoubleStrikeout(true);
textPr.SetItalic(true);
textPr.SetBold(true);
textPr.SetUnderline(true);
textPr.SetColor(0, 255, 0);
watermarkSettings.SetTextPr(textPr);
watermarkSettings.SetOpacity(127);
doc.SetWatermarkSettings(watermarkSettings);