GetAnnotOpacity

Annotations and hotspot links

Description

Returns the stroke opacity of an annotation from the /CA entry of the annotation dictionary as a value between 0.0 and 1.0

/CA holds the consistent alpha applied to markup annotations; when the entry is absent the annotation is fully opaque and the function returns 1.0

Syntax

Delphi

Function TPDFlib.GetAnnotOpacity(Index: Integer): Double;

Parameters

IndexThe index of the annotation on the currently selected page. The first annotation has an index of 1

Return values

0.0 to 1.0The stroke alpha stored in /CA, where 0.0 is fully transparent and 1.0 is fully opaque
1.0The annotation has no /CA entry, or Index does not address a readable annotation

Remarks

Call SelectPage before using this function; it operates on the annotations of the currently selected page

See also

GetAnnotColor, GetAnnotBorderWidth, GetAnnotCreationDate