GetAnnotFlags

Annotations and hotspot links

Description

Reads the /F flag field of an annotation on the selected page and returns it as a raw integer bitmask

The bits follow ISO 32000-1 Table 170 and control visibility and printing behaviour, for example the Hidden flag (value 2) removes the annotation from display and the Print flag (value 4) makes it print with the page

Syntax

Delphi

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

Parameters

Index	1-based annotation index on the selected page

Return values

>= 0	The raw `/F` value of the annotation dictionary
0	The annotation carries no `/F` entry, which is the PDF default, the index is invalid, or no document is loaded

Remarks

Flag values are 1 Invisible, 2 Hidden, 4 Print, 8 NoZoom, 16 NoRotate, 32 NoView, 64 ReadOnly, 128 Locked, 256 ToggleNoView and 512 LockedContents