Document Solutions for PDF
In This Topic
    Getting Started
    In This Topic

    System Requirements

    The DsPdf packages are fully supported on Visual Studio 2017 or later for Windows, Visual Studio for MAC, and Visual Studio Code for Linux and are compatible with the following:

    Setting up an Application

    DsPdf references are available through NuGet, a Visual Studio extension that adds the required libraries and references to your project automatically. To work with DsPdf, you need to have following references in your application:

    Reference Purpose
    DS.Documents.Pdf To use DsPdf in an application, you need to reference (install) just the DS.Documents.Pdf package. It will pull in the required infrastructure packages.
    DS.Documents.BarCode To render barcodes, install the DS.Documents.Barcode (aka DsBarcode) package. It provides extension methods allowing to render barcodes when using DsPdf.
    DS.Documents.Imaging DS.Documents.Imaging provides image handling. You do not need to reference it directly.
    DS.Documents.DX.Windows DS.Documents.DX.Windows is an infrastructure package. You do not need to reference it directly.

    Add reference to DsPdf in your application from NuGet.org

    In order to use DsPdf in a .NET Core, ASP.NET Core, .NET Framework application (any target that supports .NET Standard 2.0), install the NuGet packages in your application using the following steps:

    1. Open Visual Studio for Windows.
    2. Create a .NET Core Console/.NET Framework Windows Forms Application.
    3. Right-click the project in Solution Explorer and choose Manage NuGet Packages.
    4. In the Package source on top right, select nuget.org.
    5. Click Browse tab on top left and search for "DS.Documents".
    6. On the left panel, select DS.Documents.Pdf
    7. On the right panel, click Install.
    8. In the Preview Changes dialog, click OK and choose I Accept in the next screen.
    9. (Optional)If you want to add barcodes in your PDF file, you need to install the package DS.Documents.Barcode using the steps 5 to 8 above.

    This adds all the required references of the package to your application. After this step, follow the steps in the Quick Start section.

    1. Open Visual Studio for MAC.
    2. Create a .NET Core Console/.NET Framework Windows Forms Application.
    3. In tree view on the left, right-click Dependencies and choose Add Packages.
    4. In the Search panel, type "DS.Documents".
    5. From the list of packages displayed in the left panel, select DS.Documents.Pdf (and DS.Documents.Barcode if you want to render barcodes in your Pdfs) and click Add Packages.
    6. Click Accept.

    This automatically adds references of the package and its dependencies to your application. After this step, follow the steps in the Quick Start section.

    1. Open Visual Studio Code.
    2. Install Nuget Package Manager from Extensions.
    3. Create a folder "MyApp" in your Home folder.
    4. In the Terminal in Visual Studio Code, type "cd MyApp"
    5. Type command "dotnet new console"
      Observe: This creates a .NETCore application with MyApp.csproj file and Program.cs.
    6. Press Ctrl+Shift+P. A command line opens at the top.
    7. Type command: ">"
      Observe: "Nuget Package Manager: Add Package" option appears.
    8. Click the above option.
    9. Type "DS" and press Enter.
      Observe: DS packages get displayed in the dropdown.
    10. Choose DS.Documents.Pdf.
    11. (Optional) Repeat above steps to add DS.Documents.Barcode if you want to add barcodes to your PDF.
      Observe: The packages would be added to your .csproj file.
    12. Type following command in the Terminal window: "dotnet restore"

    This adds references of the package to your application. After this step, follow the steps in the Quick Start section.