SetAnnotCloudyEffect

Annotations and hotspot links

Description

This page describes SetAnnotCloudyEffect in PDF Library for Delphi 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.

SetAnnotCloudyEffect writes a border effect dictionary (ISO 32000-1 §12.5.4) on an annotation so its border renders as a "revision cloud" of connected semicircles, the style used to mark up drawings and plans. It sets /BE << /S /C /I n >> on Square, Circle, Polygon and FreeText annotations.

Syntax

Delphi

Function TPDFlib.SetAnnotCloudyEffect(Index, Intensity: Integer): Integer;

Parameters

Index is the 1-based index of the annotation on the selected page. Intensity selects the cloud size: 1 or 2 (matching the Cloudy 1/2 styles offered by Acrobat's UI); 0 removes the border effect again.

Return Values

Returns 1 on success, or 0 when the annotation does not exist, its subtype does not support a border effect (only Square, Circle, Polygon and FreeText do), or Intensity is outside 0..2.

Remarks

The border effect dictionary is a PDF 1.5 feature; the document version is raised automatically when the effect is applied. Annotations created by PDF Library for Delphi carry no pre-rendered appearance stream, so viewers regenerate the visual from the annotation dictionary and pick up the cloud automatically. Use GetAnnotCloudyEffect to read the setting back.