GetAnnotBorderWidth

Annotations and hotspot links

Description

Returns the border line width of an annotation on the selected page in points

The modern /BS border style dictionary is preferred; when it is missing the third element of the legacy /Border array is read, and when neither entry is present the PDF default width of 1 point is reported

Syntax

Delphi

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

Parameters

Index1-based annotation index on the selected page

Return values

>= 0The border width in points as stored in /BS /W or in the third element of the /Border array
1Default width, reported when the annotation carries neither a numeric /BS /W nor a numeric /Border width, when the index is invalid, or when no document is loaded

Remarks

When both entries are present the /BS dictionary wins, matching the precedence viewers apply when rendering

See also

SetAnnotBorderStyle, GetAnnotColor, GetAnnotOpacity