Using the NuGet Package

The recommended way of adding the PSPDFKit SDK to your project is to configure your solution to look for the local NuGet package in the SDK zip file and then add a reference to the SDK to your project.

Configure the NuGet Package Source

Rather than targeting a package held at nuget.org, you will have to set up a configuration to point to a local package.

To do this, first you will need to create a file, nuget.config, in the same directory as your solution file if one is not already present (e.g. BasicExample.sln).

The contents of the file should contain an XML element, packageSources — which describes where to find NuGet packages — as a child of a root node named configuration. If the file already exists, add the extra packageSources entry shown below. If the file is blank, copy and paste the entirety of the following contents:

Copy
1
2
3
4
5
6
<?xml version="1.0" encoding="utf-8"?>
<configuration>
   <packageSources>
       <add key="PSPDFKitSource" value="path\to\directoryContainingNupkg" />
   </packageSources>
</configuration>

Edit the value of the contents to correctly refer to the location of the directory containing the PSPDFKitUWP.*.*.*.nupkg package — for example, C:\Users\me\nugetPackages\. Now save the file, and close and reopen your solution for Visual Studio to force a read of the NuGet configuration.

Adding to the Solution

Open your app’s solution, and in the Solution Explorer, right-click on References and click on the menu item Manage NuGet Packages.... This will open the NuGet Package Manager for your solution.

On the right-hand side of the manager in the Package source dropdown window, choose the entry PSPDFKitSource (or whatever you decided to name it). You should then see the entry for PSPDFKitUWP by PSPDFKit GmbH.

On the right side, in the panel describing the package, click on the Install button to install the package.

Once that is complete, you will see a reference to the package in the Solution Explorer under References.

Note that after adding the reference to the package in this manner and then building your solution from the command line with msbuild, the switch /t:restore can be used to restore the package from the source.

Consult the Microsoft documentation for NuGet configuration for more information about what kind of sources you can specify.