Html2Pdf.Lib
0.0.9
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package Html2Pdf.Lib --version 0.0.9
NuGet\Install-Package Html2Pdf.Lib -Version 0.0.9
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Html2Pdf.Lib" Version="0.0.9" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Html2Pdf.Lib --version 0.0.9
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Html2Pdf.Lib, 0.0.9"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Html2Pdf.Lib as a Cake Addin #addin nuget:?package=Html2Pdf.Lib&version=0.0.9 // Install Html2Pdf.Lib as a Cake Tool #tool nuget:?package=Html2Pdf.Lib&version=0.0.9
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Html 2 Pdf
The best tool to convert HTML to PDF in .NET
Html2Pdf.Lib is an Open Source library with an MIT license that converts an HTML file into a PDF file.
This library was built using wkhtmltopdf, which is a command-line tool for converting HTML files to PDFs using the QT Webkit rendering engine.
No secret: The C# code simply calls the wkhtmltopdf executable and passes the necessary parameters. It's that simple: wkhtmltopdf -q --margin-bottom 10 --margin-left 10 --margin-right 10 --margin-top 10 -s A4
There are many other parameters to configure the conversion, such as page size, margins, orientation, image quality, etc.
However, it is important to note that wkhtmltopdf was discontinued in 2020, with its repository archived in 2023 and no longer supported. But it is still a widely used tool that works very well.
How to Install
dotnet add package Html2Pdf.Lib
How to Use
First, we need to define the conversion parameters. For this, we use the Arguments class.
These parameters are optional and can be configured as needed.
Basically, they are the same parameters that wkhtmltopdf accepts. If you want to know more, check out the documentation.
using Html2Pdf.Lib;
var arguments = new Arguments()
// When jpeg compressing images use this quality (default 94)
.SetImageQuality(80)
// Do not print background
.DoNotPrintBackground()
// Do not load or print images
.DoNotLoadOrPrintImages()
// Do not use lossless compression on pdf objects
.WithNoPdfCompression()
// Do not make links to remote web pages
.DisableExternalLinks()
// Do not make local links
.DisableInternalLinks()
// The title of the generated pdf file (The title of the first document is used if not specified)
.SetTitle("This is a sample PDF document")
// Indicates whether the PDF should be generated in lower quality.
.WithLowQuality()
// Number of copies to print into the PDF file.
.SetCopies(2)
// Indicates whether the PDF should be generated in grayscale.
.WithGrayScale()
// Replace [name] with value in header and footer (repeatable)
.Replace("HTML to PDF Test Page", "HTML to PDF Test Page - Sample 1")
// Set the starting page number (default 0)
.SetOffPageOffset(2)
// Sets the page margins
.SetPageMargins(10, 10, 10, 10)
// Sets the page Width. Has priority over "SetPageSize" but "SetPageHeight" has to be also specified.
.SetPageWidth(210)
// Sets the page Height. Has priority over "SetPageSize" but "SetPageWidth" has to be also specified.
.SetPageHeight(297)
// Set the page Orientation
.SetPageOrientation(PageOrientation.Landscape)
// The default page size of the rendered document is A4.
.SetPageSize(PageSize.A4)
// Disable SmartSets the page size.
.DisableSmartShrinking()
// Turn HTML form fields into pdf form fields
.EnableForms()
// Display line below the header
.DisplayHeaderLine()
// Set header text
.SetHeaderText("Header Text Sample 1", TextAlignment.Center, "Verdana", 15)
// Spacing between footer and content in mm (default 0)
.SetHeaderSpacing(23)
// Display line above the footer
.DisplayFooterLine()
// Set footer text
.SetFooterText("Footer Text Sample 1", TextAlignment.Center, "Verdana", 15)
// Spacing between footer and content in mm (default 0)
.SetFooterSpacing(23);
It is possible to generate a PDF in four ways:
From an HTML Text
var html =
"""
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>HTML Simples</title>
<style>
body {
font-family: Arial, sans-serif;
background-color: #f4f4f9;
margin: 0;
padding: 20px;
}
header {
background: #007BFF;
color: white;
padding: 10px 0;
text-align: center;
}
main {
margin-top: 20px;
text-align: center;
}
footer {
margin-top: 20px;
text-align: center;
color: #555;
}
</style>
</head>
<body>
<header>
<h1>Hello World!</h1>
</header>
<main>
<p>This is a Sample! Convert HTML to PDF</p>
</main>
<footer>
<p>© 2024 My Sample HTML</p>
</footer>
</body>
</html>
""";
var byteArrayHtml = Converter.FromHtml(html, arguments);
From Url
var url = new Uri("https://en.wikipedia.org/wiki/C_Sharp_(programming_language)");
var byteArrayUrl = Converter.FromUrl(url), arguments);
From an HTML template using Razor Syntax
public record Product(string Name, decimal Price);
public record Order(string CustomerName, string CustomerAddress, string CustomerPhoneNumber, List<Product> Products);
var razorTemplate =
"""
<!DOCTYPE html>
<html lang="pt-br">
<head>
<title>Customer Details</title>
<style>
table {
border-collapse: collapse;
width: 100%;
}
th, td {
border: 1px solid #ddd;
padding: 8px;
}
th {
background-color: #f4f4f4;
text-align: left;
}
</style>
</head>
<body>
<h1>Customer Details</h1>
<p><strong>Name:</strong> @Model.CustomerName</p>
<p><strong>Address:</strong> @Model.CustomerAddress</p>
<p><strong>Phone Number:</strong> @Model.CustomerPhoneNumber</p>
<h2>Products (@Model.Products.Count)</h2>
@if(Model.Products.Any())
{
<table>
<thead>
<tr>
<th>Product Name</th>
<th>Price</th>
</tr>
</thead>
<tbody>
@foreach (var product in Model.Products)
{
<tr>
<td>@product.Name</td>
<td>@product.Price.ToString("C")</td>
</tr>
}
</tbody>
</table>
}
else
{
<p>No products found.</p>
}
</body>
</html>
""";
var order = new Order("Roberto Rivellino", "Rua São Jorge, 777", "+55 11 912345678", [
new("Product 1", 9.99m),
new("Product 2", 19.99m),
new("Product 3", 29.99m)
]);
var byteArrayRazorTemplate = Converter.FromRazorTemplate(razorTemplate, order, arguments);
From an HTML template using Razor Syntax in Batch
var order1 = new Order("Roberto Rivellino", "Rua São Jorge, 777", "+55 11 912345678", [
new("Product 1", 9.99m),
new("Product 2", 19.99m),
new("Product 3", 29.99m)
]);
var byteArrayRazorTemplate = Converter.FromRazorTemplate(razorTemplate, order1, arguments);
var order2 = new Order("Sócrates", "Rua das Alamedas, 888", "+55 11 912345678", [
new("Product 1", 2.99m),
new("Product 2", 4.99m),
new("Product 3", 6.99m)
]);
var order3 = new Order("Biro Biro", "Avenida das Orquídeas, 999", "+55 11 912345678", [
new("Product 1", 3.99m),
new("Product 2", 5.99m),
]);
var order4 = new Order("Casagrande", "Estrada das Flores, 456", "+55 11 912345678", [ ]);
var byteArrayRazorTemplateList = Converter.FromRazorTemplateBatch(razorTemplate, [ order1, order2, order3, order4 ], arguments);
for (int i = 0; i < byteArrayRazorTemplateList.Count; i++)
{
var pdf = byteArrayRazorTemplateList.ElementAt(i);
...
}
Running on Docker
Basically you need to install wkhtmltopdf. Below is an example of a docker file.
FROM mcr.microsoft.com/dotnet/aspnet:9.0 AS base
# Install wkhtmltopdf
RUN apt-get -y update && apt-get -y upgrade
RUN apt-get -y install wkhtmltopdf
RUN wkhtmltopdf --version
USER $APP_UID
WORKDIR /app
EXPOSE 8080
EXPOSE 8081
FROM mcr.microsoft.com/dotnet/sdk:9.0 AS build
ARG BUILD_CONFIGURATION=Release
WORKDIR /src
COPY ["playground/OnDocker/Html2Pdf.OnDocker.csproj", "playground/OnDocker/"]
RUN dotnet restore "playground/OnDocker/Html2Pdf.OnDocker.csproj"
COPY . .
WORKDIR "/src/playground/OnDocker"
RUN dotnet build "Html2Pdf.OnDocker.csproj" -c $BUILD_CONFIGURATION -o /app/build
FROM build AS publish
ARG BUILD_CONFIGURATION=Release
RUN dotnet publish "Html2Pdf.OnDocker.csproj" -c $BUILD_CONFIGURATION -o /app/publish /p:UseAppHost=false
FROM base AS final
WORKDIR /app
COPY --from=publish /app/publish .
ENTRYPOINT ["dotnet", "Html2Pdf.OnDocker.dll"]
The most important part of this file is...
FROM mcr.microsoft.com/dotnet/aspnet:9.0 AS base
# Install wkhtmltopdf
RUN apt-get -y update && apt-get -y upgrade
RUN apt-get -y install wkhtmltopdf
RUN wkhtmltopdf --version
This command should be right below FROM mcr.microsoft.com/dotnet/aspnet:<<version>> AS base
You can get a complete example by accessing the link https://github.com/angelobelchior/Html2Pdf/tree/main/playground/OnDocker
How to run the code locally
macOS
Install the wkhtmltopdf executable for macOS. Or use the following command to install it via Homebrew:
brew install wkhtmltopdf
Linux
Install the wkhtmltopdf executable for Linux. Or use the following command to install it via APT:
apt-get -y update && apt-get -y upgrade
apt-get -y install wkhtmltopdf
Windows
If you are developing on a Windows machine, you need to run Visual Studio in Administrator mode.
In some cases, you will need to perform the following steps:
- Right-click on the file
./wkhtmltopdf/Windows/wkhtmltopdf.exe - Go to "Properties" and click on the "Compatibility" tab
- Then click on "Change settings for all users"
- Check the option "Run this program as an administrator".
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
| .NET Core | netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.1 is compatible. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.1
- RazorEngineCore (>= 2024.4.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.