Documents for PDF .NET Edition
In This Topic
    Getting Started
    In This Topic

    System Requirements

    GcPdf system requirements, depending upon the framework you are using to create an application, are:

    For OS versions supported in .NET Core 2.0+, see .NET Core 2.0+ - Supported OS versions.

    Setting up an Application

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

    Reference Purpose
    GrapeCity.Documents.Pdf To use GcPdf in an application, you need to reference (install) just the GrapeCity.Documents.Pdf package. It will pull in the required infrastructure packages.
    GrapeCity.Documents.BarCode To render barcodes, install the GrapeCity.Documents.Barcode (aka GcBarcode) package. It provides extension methods allowing to render barcodes when using GcPdf.
    GrapeCity.Documents.Imaging GrapeCity.Documents.Imaging provides image handling. You do not need to reference it directly.
    GrapeCity.Documents.Common GrapeCity.Documents.Common is an infrastructure package used by GcPdf and GcBarcode. You do not need to reference it directly.
    GrapeCity.Documents.Common.Windows On a Windows system, you can optionally install GrapeCity.Documents.Common.Windows. It provides support for font linking specified in the Windows registry, and access to native Windows imaging APIs, improving performance and adding some features (e.g. TIFF support).
    GrapeCity.Documents.DX.Windows GrapeCity.Documents.DX.Windows is an infrastructure package used by GrapeCity.Documents.Common.Windows. You do not need to reference it directly.

    Add reference to GcPdf in your application from NuGet.org

    In order to use GcPdf 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 any application (any target that supports .NET Standard 2.0).
    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 "Grapecity.Documents".
    6. On the left panel, select GrapeCity.Documents.Pdf
    7. On the right panel, click Install.
        Nuget Package Manager dialog                                                                             
    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 GrapeCity.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 any application (any target that supports .NET Standard 2.0).
    3. In tree view on the left, right-click Dependencies and choose Add Packages.
    4. In the Search panel, type "GrapeCity.Documents".
    5. From the list of packages displayed in the left panel, select GrapeCity.Documents.Pdf (and GrapeCity.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+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 "Grapecity" and press Enter.
      Observe: GrapeCity packages get displayed in the dropdown.
    10. Choose GrapeCity.Documents.Pdf.
    11. (Optional) Repeat above steps to add GrapeCity.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.