Skip to content

Update WinForms PdfViewer Getting Started Content #3575

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lingeshwaran-sf4984 wants to merge 1 commit into
base: development
Choose a base branch
from
Open

Update WinForms PdfViewer Getting Started Content #3575

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions Document-Processing/PDF/PDF-Viewer/winforms/Getting-Started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@ You can create a **Windows Forms Application** using Visual Studio via [Microsof

## Assemblies Deployment

To add a WinForms PdfViewer component to your application by installing it via NuGet packages(Recommended) or by manually adding the required assemblies to the project.
To add a WinForms PdfViewer component to your application by installing it via NuGet packages (Recommended) or by manually adding the required assemblies to the project.

{% tabcontents %}
{% tabcontent NuGet Package %}

The [WinForms PDF Viewer](https://www.syncfusion.com/pdf-viewer-sdk/winforms-pdf-viewer) (PdfViewerControl) and dependent assemblies can be found from the below location in your machine.
The [WinForms PDF Viewer](https://www.syncfusion.com/pdf-viewer-sdk/winforms-pdf-viewer) (PdfViewerControl) and dependent assemblies can be found at the following location on your machine.

### Install Syncfusion<sup style="font-size:70%">&reg;</sup> Windows Forms PdfViewer NuGet packages

Expand All @@ -38,7 +38,7 @@ To add **Windows Forms PdfViewer** component in the application, open the NuGet

### Add Syncfusion® WinForms PdfViewer Assemblies

Below table describes, list of assemblies required to be added in project when the [WinForms PdfViewer](https://www.syncfusion.com/pdf-viewer-sdk/winforms-pdf-viewer) control is used in your application.
The table below lists the required assemblies to be added in project when the [WinForms PdfViewer](https://www.syncfusion.com/pdf-viewer-sdk/winforms-pdf-viewer) control is used in your application.

<table>
<tr>
Expand All @@ -60,24 +60,24 @@ This library is responsible for Pdfium integration and image generation, enhanci
<tr>
<td>
Syncfusion.PdfViewer.Windows.dll</td><td>
This component contains the rendering area and other related UI elements.</td></tr>
This assembly contains the rendering area and other related UI elements.</td></tr>
<tr>
<td>
Syncfusion.Shared.Base.dll</td><td>
This component contains various UI controls (ColorPickerPalette and Numeric UpDown) that are used in the PDF Viewer.</td></tr>
This assembly contains various UI controls (ColorPickerPalette and Numeric UpDown) that are used in the PDF Viewer.</td></tr>
</table>

{% endtabcontent %}

{% endtabcontents %}

N>* Starting with version 23.1.x, Syncfusion PdfToImageConverter is necessary for PdfViewer applications.
N>* Starting with v16.2.0.x, if you reference Syncfusion<sup>&reg;</sup>; assemblies from trial setup or from the NuGet feed, you also have to include a license key in your projects. Please refer to [this link](https://help.syncfusion.com/common/essential-studio/licensing/overview) to know about registering Syncfusion&reg; license key in your Windows Forms application to use our components.
N>* Starting with version 16.2.0.x, if you reference Syncfusion<sup>&reg;</sup>; assemblies from trial setup or from the NuGet feed, you also have to include a license key in your projects. Please refer to [this licensing guide](https://help.syncfusion.com/common/essential-studio/licensing/overview) to know about registering Syncfusion&reg; license key in your Windows Forms application to use our components.


## Add Windows Forms PdfViewer component

WinForms PdfViewer control can be added to an application either through the designer (XAML) or programmatically using code.
WinForms PdfViewer control can be added to an application either through the Windows Forms Designer or programmatically using code.

{% tabcontents %}
{% tabcontent Via Designer %}
Expand All @@ -90,7 +90,7 @@ WinForms PdfViewer control can be added to an application either through the des

![Windows forms pdfviewer displays properties window of control](Getting-Started_images/Getting-Started_img2.png)

3. This will add the instance 'pdfViewerControl1' to the Designer cs file. The PDF can be loaded in the Form1.cs file using the [Load](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.PdfViewer.PdfViewerControl.html#Syncfusion_Windows_Forms_PdfViewer_PdfViewerControl_Load_System_String_) method.
3. This will add the instance 'pdfViewerControl1' to the Designer.cs file. The PDF can be loaded in the Form1.cs file using the [Load](https://help.syncfusion.com/cr/windowsforms/Syncfusion.Windows.Forms.PdfViewer.PdfViewerControl.html#Syncfusion_Windows_Forms_PdfViewer_PdfViewerControl_Load_System_String_) method.

{% tabs %}
{% highlight c# tabtitle="C#" %}
Expand Down Expand Up @@ -129,7 +129,7 @@ Imports Syncfusion.Windows.Forms.PdfViewer
{% endtabs %}


2. Create PdfViewerControl instance and load the PDF in Form1.cs.
2. Create a PdfViewerControl instance and load the PDF inside Constructor in Form1.cs. Also place the sample PDF document in the project folder.

{% tabs %}
{% highlight c# tabtitle="C#" %}
Expand All @@ -143,7 +143,7 @@ Controls.Add(pdfViewerControl1);
pdfViewerControl1.Dock = DockStyle.Fill;

//Loading the document in the PdfViewerControl
pdfViewerControl1.Load("Sample.pdf");
pdfViewerControl1.Load(@"../../Sample.pdf");

{% endhighlight %}
{% highlight vb tabtitle="VB.NET" %}
Expand All @@ -157,7 +157,7 @@ Controls.Add(pdfViewerControl1)
pdfViewerControl1.Dock = DockStyle.Fill

'Loading the document in the PdfViewerControl
pdfViewerControl1.Load("Sample.pdf")
pdfViewerControl1.Load(@"../../Sample.pdf")

{% endhighlight %}
{% endtabs %}
Expand Down