Add Syncfusion® PDF Viewer SDK Reference - WinForms or WPF Application

9 Dec 20254 minutes to read

Syncfusion® PDF Viewer SDK Reference Manager is an Add-In for WinForms and WPF application. It adds the Syncfusion^® PDF Viewer SDK assembly reference to the project, either from the GAC location or Essential Studio^® installed location. It can also migrate the projects that contain the old versions of the Syncfusion^® assembly reference to newer or specific versions of the Syncfusion^® assembly reference.

NOTE

This Syncfusion® PDF Viewer SDK Reference Manager can be applied to a project for Syncfusion^® assembly version 32.1.19 and later.

Follow the given steps to add the Syncfusion® PDF Viewer SDK Reference Manager in Visual Studio:

Before use the Syncfusion® PDF Viewer SDK Reference Manager, check whether the Syncfusion® PDF Viewer SDK Extensions - Syncfusion^® installed or not in Visual Studio Extension Manager by clicking on the Tools -> Extensions and Updates -> Installed for Visual Studio 2022 or later by clicking on the Extensions -> Manage Extensions -> Installed.If this extension not installed, please install the extension by follow the steps from the download and installation help topic.

1. Open a new or existing WinForms or WPF application.

2. To open Syncfusion® PDF Viewer SDK Reference Manager Wizard, follow either one of the options below:

   Option 1:
   Click Syncfusion^® Menu and choose Essential Studio^® for Syncfusion® PDF Viewer SDK > Add Syncfusion® PDF Viewer SDK Reference Manager….

   

   Option 2:
   Right-click the selected WinForms and WPF project file from Solution Explorer, then select Syncfusion® PDF Viewer SDK Reference Manager… from Context Menu. The following screenshot shows this option in Visual Studio.

   

3. The Syncfusion® PDF Viewer SDK Reference Manager Wizard will be loaded.

   • Windows Forms:

     

   • WPF:

     

   Choose Theme: Choose the required Theme options which is enabled only for WPF application from the dropdown.

   

   Assembly From: Choose the assembly location, either from NuGet packages, the build installed location, or by using the GAC location.

   NOTE

   The installed location and GAC option will be available only when the Syncfusion^® PDF Viewer SDK setup has been installed.

   

   Version: Choose the installed build version to add the corresponding version assemblies to the project.

   

4. click Done to add the required assemblies for the PDF Viewer SDK control into the project. The following screenshot shows the list of required assemblies for the control to be added.

   • Windows Forms:

     

   • WPF:

     

5. Click OK. The listed Syncfusion^® assemblies are added to project. Then it notifies “Syncfusion^® PDF Viewer SDK assemblies have been added successfully” in Visual Studio status bar.

6. Then, Syncfusion^® licensing registration required message box will be shown, if you installed the trial setup or NuGet packages since Syncfusion^® introduced the licensing system from 2018 Volume 2 (v16.2.0.41) Essential Studio^® release. Navigate to the help topic, which is shown in the licensing message box to generate and register the Syncfusion^® license key to your project. Refer to this blog post for understanding the licensing changes introduced in Essential Studio^®.

   

NOTE

Syncfusion^® provides Syncfusion® PDF Viewer SDK Reference Manager support for specific .NET Framework, which is shipped (assemblies) in Syncfusion^® Essential Studio^® setup. So, if you try to add Syncfusion^® assemblies in the project and project framework is not supported with selected Syncfusion^® version assemblies, the dialog appears along with “Current build v{version} is not supported this framework v{Framework Version}” message.