GetAnnotTitle

Annotations and hotspot links

Description

Returns the title of a markup annotation from the /T entry of the annotation dictionary

The title is the author label that PDF viewers display in annotation popups and review comment lists. Non-markup subtypes such as Link, Widget, Popup, Movie, Screen, PrinterMark and TrapNet never carry a title, so the function returns an empty string for them; a markup annotation without a /T entry also yields an empty string

Syntax

Delphi

Function TPDFlib.GetAnnotTitle(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 author label stored in /T
empty stringThe annotation is a non-markup subtype or carries no /T entry

Remarks

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

See also

GetAnnotSubject, GetAnnotType, GetAnnotName