GetAnnotSubject

Annotations and hotspot links

Description

Returns the subject of a markup annotation from the /Subj entry of the annotation dictionary

The subject is optional short descriptive text that viewers show next to the annotation title in comment panels. An empty string means the annotation carries no /Subj entry

Syntax

Delphi

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

Parameters

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

Return values

WideStringThe text of the /Subj entry
empty stringThe annotation has no /Subj entry

Remarks

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

See also

GetAnnotTitle, GetAnnotContentsEx, GetAnnotModifiedDate