THotPDF.GetLoadedAnnotationName Method
Gets the annotation name string for the specified page and index position in the loaded PDF document
Declaration
function GetLoadedAnnotationName(PageIndex, AnnotationIndex: Integer): AnsiString;Unit
HPDFDoc
Parameters
| Name | Purpose |
|---|---|
PageIndex | Zero-based index of the target page |
AnnotationIndex | Zero-based index of the annotation on the target page |
Return value
Returns the name string of the annotation; returns an empty string if the annotation has no name or the index is out of bounds
Usage notes
- Make sure the document is loaded and PageIndex is within the valid range before calling
- AnnotationIndex must be less than the amount returned by GetLoadedAnnotationCount for that page
- The return value is an AnsiString; if Unicode handling is required, the caller should perform the encoding conversion