Annotation - TPdf - PDFiumVCL

Component: TPdf · Unit: PDFium

Indexed property — returns the annotation record at the given index on the current page (subtype, rect, colour, contents, etc.)

Syntax

property Annotation[Index: Integer]: TPdfAnnotation; // read only

Description

Indexed read-only property that returns the annotation record at the given index on the current page (subtype, rect, colour, contents, etc.)

Requires Active to be True. The result is undefined when the index is outside the valid range; pass values in 0 .. AnnotationCount - 1 (or use the array's Length for non-counted variants).

The returned record is a snapshot of the value at the time of the call; subsequent edits to the document do not modify previously returned records.

Parameters

Index Zero-based index in the range 0 .. AnnotationCount - 1.

Remarks

The records are decoded lazily — the first access on a page may parse the /Annots, /Outlines, or /Names tree.
Edits made through TPdf (CreateAnnotation, DeleteAnnotation, etc.) invalidate any indices held by the application; re-enumerate after edits.
All coordinate fields use PDF user-space points with the origin at the bottom-left corner of the page.

Example

var
  I: Integer;
begin
  if not Pdf1.Active then Exit;
  for I := 0 to Pdf1.AnnotationCount - 1 do
  begin
    // inspect Pdf1.Annotation[I]
    Memo1.Lines.Add(IntToStr(I));
  end;
end;

Annotation property