PDFKit lets you display, edit, and manipulate PDF documents in your iOS, macOS, tvOS, and visionOS apps, with built-in views, pages, find interaction, and document outlines. You work with annotations through PDFAnnotation and its subtypes such as PDFAnnotationFreeText, PDFAnnotationInk, PDFAnnotationLink, and PDFAnnotationStamp, and configure their appearance with types like PDFBorder and PDFAppearanceCharacteristics. To wire up navigation and interactivity, you use actions such as PDFActionGoTo, PDFActionURL, and PDFActionResetForm together with PDFDestination. PDFDocumentPermissions and related types let you account for a document's access constraints as you read and modify it.
Essentials 7
The core document, page, and view objects you use to load, display, and navigate PDF content.
- ClPDFDocumentmacOS 10.4+An object that represents a PDF document and provides access to its pages, outline, and metadata.
- ClPDFPagemacOS 10.4+An object that represents a single page of a PDF document and its content.
- ClPDFViewmacOS 10.4+A view that displays the contents of a PDF document and supports scrolling and selection.
- ClPDFThumbnailViewmacOS 10.5+A view that displays thumbnail images of a document's pages for navigation.
- ClPDFOutlinemacOS 10.4+An object that represents a node in a document's hierarchical outline, or table of contents.
- ClPDFSelectionmacOS 10.4+An object that represents a selected range of text or content within a document.
- ClPDFDestinationmacOS 10.4+An object that identifies a specific point on a page used as a navigation target.
View Delegates and Overlays 3
Protocols that let you respond to view and document events and supply custom per-page overlays.
- PrPDFViewDelegateA protocol that lets a delegate respond to user interaction and navigation in a PDF view.
- PrPDFDocumentDelegateA protocol that lets a delegate respond to events from a PDF document.
- PrPDFPageOverlayViewProvidermacOS 13.0+A protocol that supplies custom overlay views to draw on top of individual pages.
Annotations 14
The base annotation class and its concrete subtypes for marking up, drawing on, and adding form fields to pages.
- ClPDFAnnotationmacOS 10.4+A base class that represents an annotation attached to a page in a PDF document.
- ClPDFAnnotationFreeTextAn annotation that displays editable free text directly on a page.
- ClPDFAnnotationInkAn annotation that captures freehand ink drawings made up of one or more paths.
- ClPDFAnnotationLinkAn annotation that links a region of a page to an action or destination.
- ClPDFAnnotationStampAn annotation that places a stamp image or label on a page.
- ClPDFAnnotationTextAn annotation that displays a note as a small icon that opens a pop-up.
- ClPDFAnnotationMarkupAn annotation that highlights, underlines, or strikes through selected text.
- ClPDFAnnotationLineAn annotation that draws a straight line with optional start and end styles.
- ClPDFAnnotationCircleAn annotation that draws a circle or ellipse on a page.
- ClPDFAnnotationSquareAn annotation that draws a rectangle or square on a page.
- ClPDFAnnotationPopupAn annotation that displays a pop-up note associated with a parent annotation.
- ClPDFAnnotationButtonWidgetA widget annotation that represents an interactive button form control on a page.
- ClPDFAnnotationChoiceWidgetA widget annotation that represents an interactive list or pop-up choice form control.
- ClPDFAnnotationTextWidgetA widget annotation that represents an interactive text field form control.
Annotation Appearance 7
Types that describe an annotation's borders, widget appearance, and named property keys.
- ClPDFBordermacOS 10.4+An object that describes the style, width, and dash pattern of an annotation's border.
- ClPDFAppearanceCharacteristicsmacOS 10.13+An object that describes the visual appearance characteristics of a widget annotation.
- StPDFAnnotationKeyA structure of keys that identify properties of a PDF annotation.
- StPDFAnnotationSubtypeA structure of constants that identify the subtype of a PDF annotation.
- StPDFAnnotationWidgetSubtypeA structure of constants that identify the subtype of a widget annotation.
- StPDFAppearanceCharacteristicsKeyA structure of keys that identify appearance characteristics of a widget annotation.
- StPDFBorderKeyA structure of keys that identify properties of an annotation border.
Annotation Style Constants 9
Constants and enumerations that specify line, markup, border, and widget styling for annotations.
- StPDFAnnotationLineEndingStyleA structure of constants that specify the style of an annotation line's endpoints.
- StPDFAnnotationTextIconTypeA structure of constants that specify the icon shown for a text annotation.
- StPDFAnnotationHighlightingModeA structure of constants that specify how a widget annotation highlights when activated.
- EnPDFLineStyleConstants that specify the endpoint style of a line annotation.
- EnPDFTextAnnotationIconTypeConstants that specify the icon displayed by a text annotation.
- EnPDFMarkupTypeConstants that specify the type of a markup annotation, such as highlight or underline.
- EnPDFWidgetControlTypeConstants that specify the control type of a widget annotation.
- EnPDFWidgetCellStateConstants that specify the on or off state of a widget annotation cell.
- EnPDFBorderStylemacOS 10.4+Constants that specify the visual style of an annotation's border.
Actions 7
The action base class and its subtypes that drive navigation and interactivity within a document.
- ClPDFActionmacOS 10.5+An abstract class that represents an action triggered by an annotation or outline item.
- ClPDFActionGoTomacOS 10.5+An action that navigates to a destination within the current document.
- ClPDFActionNamedmacOS 10.5+An action that performs a named, predefined operation such as go to next or first page.
- ClPDFActionRemoteGoTomacOS 10.5+An action that navigates to a destination in a separate PDF document.
- ClPDFActionResetFormmacOS 10.5+An action that resets the values of form fields in a document.
- ClPDFActionURLmacOS 10.5+An action that opens a URL, such as a web address, when triggered.
- EnPDFActionNamedNamemacOS 10.5+Constants that specify the predefined operation performed by a named action.
Document Attributes and Permissions 4
Types that describe document metadata, write options, and access constraints when reading or modifying a PDF.
- StPDFDocumentAttributeA structure of keys that identify metadata attributes of a PDF document.
- StPDFDocumentWriteOptionA structure of keys that specify options for writing a document to disk.
- EnPDFDocumentPermissionsmacOS 10.4+Constants that specify the access permission level granted by a document.
- EnPDFAccessPermissionsAn option set that describes the specific access operations a document allows.
Display and Selection Options 7
Enumerations that configure how content is laid out, rendered, and selected in a view.
- EnPDFDisplayBoxmacOS 10.4+Constants that specify which page box, such as media or crop, is used for display.
- EnPDFDisplayModemacOS 10.4+Constants that specify how pages are laid out in a PDF view.
- EnPDFDisplayDirectionmacOS 10.13+Constants that specify whether pages scroll vertically or horizontally.
- EnPDFSelectionGranularitymacOS 15.0+Constants that specify the granularity of a text selection, such as character or word.
- StPDFAreaOfInterestmacOS 10.4+An option set that describes the kinds of content under a point in a PDF view.
- EnPDFInterpolationQualitymacOS 10.7+Constants that specify the image interpolation quality used when rendering content.
- EnPDFPrintScalingModemacOS 10.4+Constants that specify how page content is scaled when printing a document.
Extends 1
NSNotification