Section:

Integrate Apryse SDK into your Xamarin.Forms application

Welcome to Apryse. This guide will show you how to get started with integrating a free trial of the Apryse SDK into your Xamarin.Forms application. We will clone the Xamarin.Forms sample repository, walk through the project structure, and show you how to customize the Apryse components of your Xamarin.Forms app. Your free trial includes unlimited trial usage and support from solution engineers.

Prerequisites

  • Latest version of Visual Studio

No trial license key required.

The trial of Apryse Mobile SDK does not require a trial key. A commercial license key is required for use in a production environment. Please contact sales to purchase a commercial key or if you need any other license key assistance.

Keep your license keys confidential.

License keys are uniquely generated. Please make sure that it is not publicly available (e.g. in your public GitHub).

Initial setup

  1. Clone the Xamarin.Forms sample by executing

sh

1git clone https://github.com/ApryseSDK/xamarin-forms-sample.git
  1. Open CustomRenderer.sln in Visual Studio.

You are now ready to run the sample. If you want to run the UWP sample as well, follow the steps below:

Optional, for UWP only

  1. Download and extract the UWP project.
  2. Run the PDFNetUWPApps.vsix from /PDFNetUWPApps/Lib to install PDFNet SDK for UWP.
  3. From the UWP download package, copy the /Samples/PDFViewCtrlTools_VS2015 folder to the Xamarin.Forms sample folder ContentPage.
  4. Find the existing PDFNet SDK for UWP reference in the CustomRenderer.UWP sample and delete it.

sh

1![Delete existing](img/remove-existing.png)
  1. Right click the CustomRenderer.UWP project and add a reference to the PDFNet SDK for UWP extension that was installed from the download package.

sh

1![Add Reference](img/add-reference.png)
2![Select Apryse for UWP](img/sdk-uwp.png)

Sample overview

After initial setup, your xamarin-forms-sample/ContentPage folder should look like this(assuming you followed UWP integration steps):

sh

1xamarin-forms-sample
2├── ContentPage
3│   ├── CustomRenderer
4│   ├── Droid
5│   ├── iOS
6│   ├── packages
7│   ├── PDFViewCtrlTools_VS2015
8│   ├── UWP
9│   └── CustomRenderer.sln
10└── ...

Notable files and directories include:

File/Folder Name

Description

CustomRenderer

Contains the declaration for the shared Xamarin.Forms page

Droid

Contains custom renderer for Xamarin.Android

iOS

Contains custom renderer for Xamarin.iOS

packages

Contains the dependencies for the project

PDFViewCtrlTools_VS2015

Annotation and UI tools project for UWP sample that was imported from Apryse UWP SDK

UWP

Contains custom renderer for UWP

CustomRenderer.sln

The Visual Studio solution file for the entire sample

Run the sample

The process of running the sample is the same for all samples you want to run.

  1. Right click the solution CustomRenderer and click Restore NuGet Packages to install the project dependencies.

2. Build the solution by right clicking CustomRenderer and selecting Build Solution. 3. Run the project sample of your choice. Regardless of which project you ran, you will see a selection screen pop up which asks you to run either the Basic Viewer or the Advanced Viewer.

Apryse Docs Image

For reference, this is how the Basic Viewer should look on all three platforms:

Android

iOS

UWP

Apryse Docs Image
Apryse Docs Image
Apryse Docs Image

For a more involved guide on how to integrate Apryse SDK into a Xamarin.Forms project, check out this guide for the advanced viewer and this guide for the basic viewer .

You can view the source code for this project here.

Did you find this helpful?

Trial setup questions?

Ask experts on Discord

Need other help?

Contact Support

Pricing or product questions?

Contact Sales