About PSPDFKit for iOS

PSPDFKit is the best framework for working with PDF files on all modern platforms. It includes tools to display PDFs, edit PDFs, create PDFs, create/edit annotations, fill out forms and create/verify digital signatures.

At a Glance

While the amount of API might look overwhelming at first, you usually only need a subset of these classes but have the power to customize almost anything. We chose to expose a lot of API so that every aspect can be customized, however most settings have good and sensible defaults and you don’t need to know about all classes to start using it.

Here’s the list of classes you will most likely use:

• Document — The base class for your PDFs. It can contain multiple document sources from files, data blobs or even custom data providers.
• PDFDocumentDelegate — Be notified when the document is being saved.
• PDFViewController — The main view controller to display a Document.
• PDFViewControllerDelegate — A delegate to respond to user actions like tapping on a link.
• PDFConfiguration — To configure the PDFViewController.
• PDFLibrary — Provides full-text search across multiple documents.
• PDFDocumentPickerController — A handy document picker table view that also allows search.
• Processor — Create new documents or password-protect existing ones.
• Annotation — The base class for all annotation objects.
• AnnotationToolbar — The toolbar to add annotations.
• AnnotationStateManager — Manages special states to create annotations (drawings, etc.).
• Glyph — Represents a single character in a PDF document. Use Document.objects(atPDFRect:pageIndex:options:) to extract from pages.
• PDFCache — Fine-tune the caching behavior or clear the disk cache.

Using the PDFConfigurationBuilder.overrideClass(_:with:) method, you can override almost any class of the controller or view layer (using PDFViewController) or the model layer (using Document) with your own subclass. Use this to customize details that are deep within PSPDFKit with minimum effort. You find some examples for this in the Catalog example app.

Integration

Visit pspdfkit.com/guides for a step-by-step guide to integrate PSPDFKit.

Instant

You can find the API documentation for PSPDFKit Instant at pspdfkit.com/api/ios/Instant.html.

License

PSPDFKit is commercially licensed. Contact us at sales@pspdfkit.com. Copyright © 2010-2023 PSPDFKit GmbH.

Support

Feel free to submit a support ticket if you have any questions or bug reports.