GetAnnotStateModel

Annotations and hotspot links

Description

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

GetAnnotStateModel reads the /StateModel text string of a review-state Text annotation (ISO 32000-1 §12.5.6.3): either Review or Marked.

Syntax

Delphi

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

Parameters

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

Return Values

Returns the /StateModel value as a string (Review or Marked), or an empty string when the annotation carries no /StateModel entry.

Remarks

Pair with GetAnnotState for the state value itself. State annotations are created with AddAnnotationState.