GetAnnotState

Annotations and hotspot links

Description

This page describes GetAnnotState 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.

GetAnnotState reads the /State text string of a review-state Text annotation (ISO 32000-1 §12.5.6.3), such as Accepted, Rejected, Cancelled, Completed, None, Marked or Unmarked.

Syntax

Delphi

Function TPDFlib.GetAnnotState(Index: Integer): WideString;

Parameters

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

Return Values

Returns the /State value as a string, or an empty string when the annotation carries no /State entry (ordinary annotations that are not review-state replies).

Remarks

Pair with GetAnnotStateModel to learn which state model the value belongs to, and with GetAnnotIntProperty Tag 128 to resolve the 1-based index of the annotation the reply refers to. State annotations are created with AddAnnotationState.