Some test text!

Search
Hamburger Icon

iOS / Guides

Adding PDFNet to your project

This guide explains how to aquire PDFNet and add it to your project. Once PDFNet is part of your project, please see how to show a PDF to get started using PDFNet.

Development Requirements
  • PDFNet requires the latest release version of Xcode available at the time of the SDK's release.
  • PDFNet supports the two most recent major versions of iOS at the time of its release (currently iOS 10 and iOS 11).

There are two ways to download and add PDFNet to an app: manually or with Cocoapods.

The manual download includes the framework binaries, sample projects and source code for the UI framework (Tools.framework ); Cocoapods includes only the framework binaries only.

Manual Integration (Dynamic Framework)

  1. Download the SDK: .

  2. Copy the /Lib directory to an appropriate location for your project.

  3. Drag the dynamic PDFNet and Tools frameworks (Lib/Framework-dynamic/PDFNet.framework, Lib/Tools/Tools.framework) into the "Embedded Binaries" section of your project, as indicated below.

    Add the frameworks to the project

    The pink rectangle shows where to drag PDFNet.framework and Tools.framework
  4. In your target's build phases, a) add a new run script phase (by clicking on the '+'), and b) add the following script:

bash "$BUILT_PRODUCTS_DIR/$FRAMEWORKS_FOLDER_PATH/PDFNet.framework/strip-framework.sh"

This will ensure invalid slices are striped from the framework before being submitted to the app store (a longstanding Xcode bug).

![Add the script to the project](./img/add-script.png)
<div class='label'>Create a new run script phase, and add the text as shown.</div>

Cocoapods Integration

PDFNet is available via Cocoapods. The Cocoapods package does not include sample code or source code for the UI framework Tools.framework — please use the manual download for these.

To integrate PDFNet with Cocoapods, include one of the following code blocks in your pod file. The first block is recommended for most use cases.

Option 1: For the latest release of bothPDFNet.framework and Tools.framework:

target '<Your-Target-Name>' do
  use_frameworks!
  pod 'PDFNet', podspec: 'https://www.pdftron.com/downloads/ios/staging/cocoapods/pdfnet/latest.podspec'
end

Then, run pod install.

Option 2: For the a specific release of bothPDFNet.framework and Tools.framework:

target '<Your-Target-Name>' do
  use_frameworks!
  pod 'PDFNet', podspec: 'https://www.pdftron.com/downloads/ios/staging/cocoapods/pdfnet/6.10.4.70914.podspec'
end

Then, run pod install.

Option 3: For the latest release of PDFNet.frameworkonly (for if you are using a customized version of Tools.framework):

target '<Your-Target-Name>' do
  use_frameworks!
  pod 'PDFNet', podspec: 'https://www.pdftron.com/downloads/ios/staging/cocoapods/pdfnet-no-tools/latest.podspec'
end

Then, run pod install.

Option 4: For a specific release of PDFNet.frameworkonly (for if you are using a customized version of Tools.framework):

target '<Your-Target-Name>' do
  use_frameworks!
  pod 'PDFNet', podspec: 'https://www.pdftron.com/downloads/ios/staging/cocoapods/pdfnet-no-tools/6.10.4.70914.podspec'
end

Then, run pod install.

Note: Cocoapods distributes the dynamic framework only. If you wish to use the static framework, you will have to integrate it manually.

Get the answers you need: Chat with us