GetAnnotType

Annotations and hotspot links

Description

Returns the subtype name of an annotation from the /Subtype entry of the annotation dictionary, without the leading slash

Typical results are Text, Link, Highlight, FreeText, Stamp or Widget, so the string can be compared directly against the subtype literals used elsewhere in the library. An empty string means the annotation dictionary has no readable /Subtype name

Syntax

Delphi

Function TPDFlib.GetAnnotType(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 /Subtype name without the leading slash
empty stringThe annotation dictionary carries no /Subtype name

Remarks

Call SelectPage before using this function; it operates on the annotations of the currently selected page. Several property readers, for example GetAnnotLineEndings, accept only specific subtypes and rely on this function for the check

See also

AnnotationCount, GetAnnotTitle, GetAnnotRectEx, SelectPage