API reference

Annotations

95 functions. Every declaration on the detail pages is extracted from the shipped bindings.

Annotations

pdfGetAnnot Read an annotation's core metadata (type, bounding box) by its
pdfGetAnnotBBox Read an annotation's /Rect bounding box by document-wide
pdfGetAnnotColor Set/get an annotation's border color (ColorType=1, PDF
pdfGetAnnotCount Return the total number of annotations across every page
pdfGetAnnotEx Read an annotation's core metadata (type, bounding box) by its
pdfGetAnnotFlags Set/get the PDF /F annotation-flags bitmask — on the
pdfGetAnnotLink Update an existing Web Link's target URL
pdfGetAnnotSoundToFile Extract a legacy Sound annotation's embedded audio bytes
pdfGetAnnotSoundToString Extract a legacy Sound annotation's embedded audio bytes
pdfGetAnnotTextAlign Read a FreeText annotation's /Q text-justification value
pdfGetAnnotType Return an annotation's TAnnotType ordinal by document-wide
pdfSetAnnotBorderEffect Set an annotation's /BE border-effect (beSolid,
pdfSetAnnotBorderStyle Set an annotation's /BE border-effect (beSolid,
pdfSetAnnotBorderWidth Set an annotation's /BE border-effect (beSolid,
pdfSetAnnotColor Set/get an annotation's border color (ColorType=1, PDF
pdfSetAnnotDblProperty A generic, tag-indexed property setter trio — despite the
pdfSetAnnotFlags Set/get the PDF /F annotation-flags bitmask — on the
pdfSetAnnotFlagsEx Set/get the PDF /F annotation-flags bitmask — on the
pdfSetAnnotHighlightMode Set a per-annotation /H mouse-down highlight mode
pdfSetAnnotIcon Set a Text (sticky-note) annotation's /Name icon (Comment,
pdfSetAnnotIntProperty A generic, tag-indexed property setter trio — despite the
pdfSetAnnotLineDashPattern Set an annotation's /BS /D dash pattern (works on any
pdfSetAnnotLineEndStyle Set an annotation's /BS /D dash pattern (works on any
pdfSetAnnotMigrationState Set an annotation's review/migration state (e.g. Accepted/
pdfSetAnnotOpacity Set an annotation's /CA (constant opacity) value.
pdfSetAnnotOpenState Set whether a popup-bearing annotation (Text, FreeText, etc.)
pdfSetAnnotOrFieldDate Set a date value on either an annotation or a form field
pdfSetAnnotQuadPoints Set the /QuadPoints array on a markup annotation
pdfSetAnnotString Set one of several text fields on an annotation
pdfSetAnnotStrProperty A generic, tag-indexed property setter trio — despite the
pdfSetAnnotSubject Set one of several text fields on an annotation

Bookmarks

pdfInsertBookmark Insert a new bookmark node — targeting a page directly
pdfInsertBookmarkEx Insert a new bookmark node — targeting a page directly

Core

pdfCaretAnnot Create a Caret annotation (the text-insertion "^" marker).
pdfChangeAnnotName Set an annotation's /NM (name/identifier) string.
pdfChangeAnnotPos Reposition/resize an existing annotation's /Rect.
pdfChangeBookmark Update an existing bookmark's title, parent, target page, and
pdfChangeLinkAnnot Update an existing Web Link's target URL
pdfCircleAnnot Create a Circle (ellipse-inscribed-in-bbox) or Square
pdfCloneOutlineAction Duplicate an outline node's attached action onto a new/other
pdfCompareOutlines Duplicate an outline node's attached action onto a new/other
pdfDeleteAnnotation Remove an annotation — either everywhere in the document
pdfDeleteAnnotationFromPage Remove an annotation — either everywhere in the document
pdfDeleteBookmark Remove a bookmark node (pdfDeleteBookmark), or swap the
pdfExchangeBookmarks Remove a bookmark node (pdfDeleteBookmark), or swap the
pdfFileAttachAnnot Create a FileAttachment ("paperclip") annotation, either
pdfFileAttachAnnotEx Create a FileAttachment ("paperclip") annotation, either
pdfFileLink Create a Link annotation targeting an external URI
pdfFindBookmark Search the outline tree by title text and/or target page;
pdfFindLinkAnnot Update an existing Web Link's target URL
pdfFindNextBookmark Search the outline tree by title text and/or target page;
pdfFlattenAnnotOrField Flatten a single annotation or form field, addressed by a
pdfFlattenAnnots Flatten every annotation in the document in one call
pdfFreeTextAnnot Create a FreeText annotation — text drawn directly on the
pdfHighlightAnnot Create one of the 4 text-markup annotation types —
pdfInkAnnot Create an Ink (freehand pen-stroke) annotation from a single
pdfLineAnnot Create a Line annotation between two points with optional end
pdfPageLink Four distinct ways to create an in-document jump Link
pdfPageLink2 Four distinct ways to create an in-document jump Link
pdfPageLink3 Four distinct ways to create an in-document jump Link
pdfPageLinkEx Four distinct ways to create an in-document jump Link
pdfPolygonAnnot Create a PolyLine (open, /Subtype /PolyLine) or Polygon
pdfPolyLineAnnot Create a PolyLine (open, /Subtype /PolyLine) or Polygon
pdfResetAnnotAP Manage an annotation's /AP appearance-stream dictionary:
pdfResolveBookmarkDest Resolve a bookmark's destination page on demand, for
pdfRichMediaAnnot Create a RichMedia annotation embedding an external media file
pdfSelectAnnotAPStream Manage an annotation's /AP appearance-stream dictionary:
pdfSquareAnnot Create a Circle (ellipse-inscribed-in-bbox) or Square
pdfStampAnnot Create a Rubber Stamp annotation using one of the standard
pdfTextAnnot Create a Text ("sticky note") annotation.
pdfWatermarkAnnot Create a Watermark annotation on the current open page.
pdfWebLink Create a Link annotation targeting an external URI

Getters

pdfGet3DAnnotStream Read back a 3D annotation's embedded U3D stream bytes and
pdfGetBookmark Read a bookmark's metadata (title, color, parent, style, open
pdfGetBookmarkCount Read a bookmark's metadata (title, color, parent, style, open
pdfGetBookmarkEx Read a bookmark's metadata (title, color, parent, style, open
pdfGetImportPageLink Read link-annotation rectangles and their target page out of
pdfGetImportPageLinkCount Read link-annotation rectangles and their target page out of
pdfGetLinkHighlightMode Set/get the document-global default /H highlight mode
pdfGetOutlineObjectNumber Duplicate an outline node's attached action onto a new/other
pdfGetPageAnnot Enumerate the annotations on whichever page is currently
pdfGetPageAnnotCount Enumerate the annotations on whichever page is currently
pdfGetPageAnnotEx Enumerate the annotations on whichever page is currently

Import

pdfImportBookmarks Copy the currently open import file's entire outline tree
pdfImportPendingAnnots Materialise annotations that a lazy import has deferred, so

Object Creation

pdfCreate3DAnnot Create a 3D annotation embedding a U3D model file.
pdfCreateAnnotAP Manage an annotation's /AP appearance-stream dictionary:

Setters

pdfSet3DAnnotProps Configure a 3D annotation's activation/deactivation behavior
pdfSet3DAnnotScript Configure a 3D annotation's activation/deactivation behavior
pdfSetBookmarkDest Set a bookmark's destination-array kind and its up-to-4
pdfSetBookmarkStyle Set a bookmark's display style — bold/italic flags and text
pdfSetLineAnnotParms Create a Line annotation between two points with optional end
pdfSetLineAnnotPoints Create a Line annotation between two points with optional end
pdfSetLinkHighlightMode Set/get the document-global default /H highlight mode

Validation

pdfCheckPageAnnots Scan every page's annotation list for structurally malformed