Skip to main content

SetBorderEffectIntensity

Sets annotation border effect intensity. 💡 Can be applied to circle, square, freeText and polygon annotations

Syntax

expression.SetBorderEffectIntensity(value);

expression - A variable that represents a ApiBaseAnnotation class.

Parameters

NameRequired/OptionalData typeDefaultDescription
valueRequirednumberThe border effect intensity. Must be greater than or equal to 0.

Returns

boolean

Example

Control the strength of a border effect on an annotation in a PDF.

// How strong should a border effect appear on an annotation in a PDF?

// Adjust the intensity level of a visual effect applied to an annotation's border in a PDF.

let doc = Api.GetDocument();
let squareAnnot = Api.CreateSquareAnnot([10, 10, 160, 32]);
let page = doc.GetPage(0);
page.AddObject(squareAnnot);
squareAnnot.SetBorderEffectStyle("cloud");
squareAnnot.SetBorderEffectIntensity(1);