Convert HTML to PDF file in ASP.NET Core

20 Feb 20259 minutes to read

The Syncfusion® HTML to PDF converter is a .NET library used to convert HTML or web pages to PDF document in ASP.NET Core application.

To quickly get started with converting HTML to PDF in ASP.NET Core using the HTML-to-PDF Library. Please, check this video:

Steps to convert HTML to PDF in ASP.NET Core application

Prerequisites:

  • Visual Studio 2022.
  • Install .NET 8 SDK or later.

Step 1: Create a new C# ASP.NET Core Web Application project. Create ASP.NET Core Web application

Step 2: In configuration windows, name your project and select Next. Configuration window1 Configuration window2

Step 3: Install Syncfusion.HtmlToPdfConverter.Net.Windows NuGet package as reference to your .NET Standard applications from NuGet.org.
NuGet package installation

NOTE

Starting with v16.2.0.x, if you reference Syncfusion® assemblies from trial setup or from the NuGet feed, you also have to add “Syncfusion.Licensing” assembly reference and include a license key in your projects. Please refer to this link to know about registering Syncfusion® license key in your application to use our components.

Step 4: A default controller with name HomeController.cs gets added on creation of ASP.NET Core MVC project. Include the following namespaces in that HomeController.cs file.

  • C#
    • using Syncfusion.Pdf;
using Syncfusion.HtmlConverter;
using System.IO;

    Step 5: Add a new button in index.cshtml as shown below.

  • C#
    • @{Html.BeginForm("ExportToPDF", "Home", FormMethod.Post);
    {
        <div>
            <input type="submit" value="Convert HTML to PDF" style="width:150px;height:27px" />
        </div>
    }
    Html.EndForm();
}

    Step 6: Add a new action method named ExportToPDF in HomeController.cs and include the below code example to convert HTML to PDF document using Convert method in HtmlToPdfConverter class. The HTML content will be scaled based on the given ViewPortSize property of BlinkConverterSettings class.

  • C#
    • //Initialize HTML to PDF converter.
HtmlToPdfConverter htmlConverter = new HtmlToPdfConverter();
BlinkConverterSettings blinkConverterSettings = new BlinkConverterSettings();
//Set Blink viewport size.
blinkConverterSettings.ViewPortSize = new Syncfusion.Drawing.Size(1280, 0);
//Assign Blink converter settings to HTML converter.
htmlConverter.ConverterSettings = blinkConverterSettings;
//Convert URL to PDF document.
PdfDocument document = htmlConverter.Convert("https://www.syncfusion.com");
//Create memory stream.
MemoryStream stream = new MemoryStream();
//Save and close the document. 
document.Save(stream);
document.Close(); 
return File(stream.ToArray(), System.Net.Mime.MediaTypeNames.Application.Pdf, "HTML-to-PDF.pdf");

    Step 7: Build the project.

    Click on Build > Build Solution or press Ctrl + Shift + B to build the project.

    Step 8: Run the project.

    Click the Start button (green arrow) or press F5 to run the app.

    Prerequisites:

    • Install .NET SDK: Ensure that you have the .NET SDK installed on your system. You can download it from the .NET Downloads page.
    • Install Visual Studio Code: Download and install Visual Studio Code from the official website.
    • Install C# Extension for VS Code: Open Visual Studio Code, go to the Extensions view (Ctrl+Shift+X), and search for ‘C#’. Install the official C# extension provided by Microsoft.

    Step 1: Open the terminal (Ctrl+` ) and run the following command to create a new ASP.NET Core Web Application project.

    dotnet new mvc -n CreatePdfASPNETCoreAPP

    Step 2: Replace **CreatePdfASPNETCoreAPP with your desired project name.

    Step 3: Navigate to the project directory using the following command

    cd CreatePdfASPNETCoreAPP

    Step 4: Use the following command in the terminal to add the Syncfusion.HtmlToPdfConverter.Net.Windows package to your project.

    dotnet add package Syncfusion.HtmlToPdfConverter.Net.Windows

    NOTE

    Starting with v16.2.0.x, if you reference Syncfusion® assemblies from trial setup or from the NuGet feed, you also have to add “Syncfusion.Licensing” assembly reference and include a license key in your projects. Please refer to this link to know about registering Syncfusion® license key in your application to use our components.

    Step 5: A default controller with name HomeController.cs gets added on creation of ASP.NET Core MVC project. Include the following namespaces in that HomeController.cs file.

  • C#
    • using Syncfusion.Pdf;
using Syncfusion.HtmlConverter;
using System.IO;

    Step 6: Add a new button in index.cshtml as shown below.

  • C#
    • @{Html.BeginForm("ExportToPDF", "Home", FormMethod.Post);
    {
        <div>
            <input type="submit" value="Convert HTML to PDF" style="width:150px;height:27px" />
        </div>
    }
    Html.EndForm();
}

    Step 7: Add a new action method named ExportToPDF in HomeController.cs and include the below code example to convert HTML to PDF document using Convert method in HtmlToPdfConverter class. The HTML content will be scaled based on the given ViewPortSize property of BlinkConverterSettings class.

  • C#
    • //Initialize HTML to PDF converter.
HtmlToPdfConverter htmlConverter = new HtmlToPdfConverter();
BlinkConverterSettings blinkConverterSettings = new BlinkConverterSettings();
//Set Blink viewport size.
blinkConverterSettings.ViewPortSize = new Syncfusion.Drawing.Size(1280, 0);
//Assign Blink converter settings to HTML converter.
htmlConverter.ConverterSettings = blinkConverterSettings;
//Convert URL to PDF document.
PdfDocument document = htmlConverter.Convert("https://www.syncfusion.com");
//Create memory stream.
MemoryStream stream = new MemoryStream();
//Save and close the document. 
document.Save(stream);
document.Close(); 
return File(stream.ToArray(), System.Net.Mime.MediaTypeNames.Application.Pdf, "HTML-to-PDF.pdf");

    Step 8: Build the project.

    Run the following command in terminal to build the project.

    dotnet build

    Step 9: Run the project.

    Run the following command in terminal to build the project.

    dotnet run

    Prerequisites:

    • JetBrains Rider.
    • Install .NET 8 SDK or later.

    Step 1. Open JetBrains Rider and create a new ASP.NET Core Web application project.

    • Launch JetBrains Rider.
    • Click new solution on the welcome screen.

    Launch JetBrains Rider

    • In the new Solution dialog, select Project Type as Web.
    • Select the target framework (e.g., .NET 8.0, .NET 9.0) and template as Web App(Model-View-Controller).
    • Enter a project name and specify the location.
    • Click create.

    Creating a new ASP.NET Core Web application project in JetBrains Rider

    Step 2: Install the NuGet package from NuGet.org.

    • Click the NuGet icon in the Rider toolbar and type Syncfusion.HtmlToPdfConverter.Net.Windows in the search bar.
    • Ensure that “nuget.org” is selected as the package source.
    • Select the latest Syncfusion.HtmlToPdfConverter.Net.Windows NuGet package from the list.
    • Click the + (Add) button to add the package.

    Select the Syncfusion.HtmlToPdfConverter.Net.Windows package

    • Click the Install button to complete the installation.

    Install the package

    NOTE

    Starting with v16.2.0.x, if you reference Syncfusion® assemblies from trial setup or from the NuGet feed, you also have to add “Syncfusion.Licensing” assembly reference and include a license key in your projects. Please refer to this link to know about registering Syncfusion® license key in your application to use our components.

    Step 4: A default controller with name HomeController.cs gets added on creation of ASP.NET Core MVC project. Include the following namespaces in that HomeController.cs file.

  • C#
    • using Syncfusion.Pdf;
using Syncfusion.HtmlConverter;
using System.IO;

    Step 5: Add a new button in index.cshtml as shown below.

  • C#
    • @{Html.BeginForm("ExportToPDF", "Home", FormMethod.Post);
    {
        <div>
            <input type="submit" value="Convert HTML to PDF" style="width:150px;height:27px" />
        </div>
    }
    Html.EndForm();
}

    Step 6: Add a new action method named ExportToPDF in HomeController.cs and include the below code example to convert HTML to PDF document using Convert method in HtmlToPdfConverter class. The HTML content will be scaled based on the given ViewPortSize property of BlinkConverterSettings class.

  • C#
    • //Initialize HTML to PDF converter.
HtmlToPdfConverter htmlConverter = new HtmlToPdfConverter();
BlinkConverterSettings blinkConverterSettings = new BlinkConverterSettings();
//Set Blink viewport size.
blinkConverterSettings.ViewPortSize = new Syncfusion.Drawing.Size(1280, 0);
//Assign Blink converter settings to HTML converter.
htmlConverter.ConverterSettings = blinkConverterSettings;
//Convert URL to PDF document.
PdfDocument document = htmlConverter.Convert("https://www.syncfusion.com");
//Create memory stream.
MemoryStream stream = new MemoryStream();
//Save and close the document. 
document.Save(stream);
document.Close(); 
return File(stream.ToArray(), System.Net.Mime.MediaTypeNames.Application.Pdf, "HTML-to-PDF.pdf");

    Step 7: Build the project.

    Click the Build button in the toolbar or press Ctrl+Shift+B to build the project.

    Step 8: Run the project.

    Click the Run button (green arrow) in the toolbar or press F5 to run the app.

    By executing the program, you will get the PDF document as follows.
    HTML to PDF output document

    A complete working sample can be downloaded from Github.

    Click here to explore the rich set of Syncfusion® HTML to PDF converter library features.

    An online sample link to convert HTML to PDF document in ASP.NET Core.