GetAnnotName

Annotations and hotspot links

Description

Returns the unique annotation name from the /NM entry of the annotation dictionary

The name is optional in PDF and identifies one annotation uniquely within a document, which makes it a stable key for tracking an annotation across incremental updates and revisions. An empty string means the annotation carries no /NM entry

Syntax

Delphi

Function TPDFlib.GetAnnotName(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 /NM entry
empty stringThe annotation has no /NM entry

Remarks

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

See also

GetAnnotModifiedDate, GetAnnotTitle, AnnotationCount