GetAnnotCloudyEffect

Annotations and hotspot links

Description

This page describes GetAnnotCloudyEffect in PDFlibPas under the "Annotations and hotspot links" topic. API names, parameters, class names, filenames, and literals are kept exactly as they appear in the Delphi library and DLL entry points.

GetAnnotCloudyEffect reads the border effect dictionary (ISO 32000-1 §12.5.4) of an annotation and reports whether its border renders as a revision cloud.

Syntax

Delphi

Function TPDFlib.GetAnnotCloudyEffect(Index: Integer): Integer;

Parameters

Index is the 1-based index of the annotation on the selected page.

Return Values

Returns 0 when the annotation carries no cloudy border (no /BE entry, or its /S style is not /C), otherwise the cloud intensity clamped to 1..2 (a nonstandard cloudy /I of 0 reads as 1).

Remarks

Cloudy borders are written with SetAnnotCloudyEffect. Only Square, Circle, Polygon and FreeText annotations support the border effect dictionary.