Installing wkhtmltopdf for C#

1. Download the current version for Windows from the official website URL: wkhtmltopdf Downloads
2. Double-click the downloaded installer and follow the instructions in the installation wizard to install wkhtmltopdf.

3. Once installed, modify the path by adding the wkhtmltopdf executable to your system's PATH environment variable. This can be done via the command prompt using the following command:

   set PATH=%PATH%;C:\Program Files\wkhtmltopdf\bin

   set PATH=%PATH%;C:\Program Files\wkhtmltopdf\bin

   SHELL

Installing wkhtmltopdf for Java

1. Download the latest version of wkhtmltopdf for Windows from the official website: wkhtmltopdf Downloads
2. Extract the contents of the downloaded archive to a destination folder on your system.

In both C# and Java, the installation and usage of wkhtmltopdf involve executing the wkhtmltopdf command via the command prompt or using the ProcessBuilder class to execute the command programmatically. It is important to ensure that the wkhtmltopdf executable is added to the system's PATH environment variable and that the necessary switches and options are provided to generate the desired output PDF file. For teams looking to transition away from wkhtmltopdf, the step-by-step wkhtmltopdf to IronPDF migration guide covers the process in detail.

To install IronPDF for C#

1. Install the IronPDF NuGet package using the Package Manager Console or via the Visual Studio UI.

2. In your code, add the following using statement to import the IronPDF namespace:

   using IronPdf;

   using IronPdf;

   $vbLabelText   $csharpLabel

3. To generate a PDF from an HTML string, use the following code:

   var Renderer = new ChromePdfRenderer();
   Renderer.RenderHtmlAsPdf("IronFile.html").SaveAs("IronPDF-file.pdf");

   var Renderer = new ChromePdfRenderer();
   Renderer.RenderHtmlAsPdf("IronFile.html").SaveAs("IronPDF-file.pdf");

   $vbLabelText   $csharpLabel

4. To create a PDF from scratch, use the following code:

   using IronPdf;
   
   var Renderer = new ChromePdfRenderer();
   // Create a PDF from a URL or local file path
   using var pdf = Renderer.RenderUrlAsPdf("https://www.amazon.com/?tag=hp2-brobookmark-us-20");
   // Export to a file or a Stream 
   pdf.SaveAs("url.pdf");

   using IronPdf;
   
   var Renderer = new ChromePdfRenderer();
   // Create a PDF from a URL or local file path
   using var pdf = Renderer.RenderUrlAsPdf("https://www.amazon.com/?tag=hp2-brobookmark-us-20");
   // Export to a file or a Stream 
   pdf.SaveAs("url.pdf");

   $vbLabelText   $csharpLabel

To install IronPDF for Java

1. Download the IronPDF Java Library from the IronPDF website.
2. Add the IronPDF JAR file to your project's classpath.

3. In your code, import the IronPDF package:

   import com.ironsoftware.ironpdf.*;

   import com.ironsoftware.ironpdf.*;

   JAVA

4. Once installed, generate a PDF from HTML content using the following code:

   import com.ironsoftware.ironpdf.*;
   import java.io.IOException;
   import java.nio.file.Paths;
   
   public class PdfExample {
      public static void main(String[] args) throws IOException {
          // Apply your license key 
          License.setLicenseKey("YOUR-LICENSE-KEY");
   
          // Set a log path 
          Settings.setLogPath(Paths.get("C:/tmp/IronPdfEngine.log"));
   
          // Render the HTML as a PDF, stored in myPdf as type PdfDocument
          PdfDocument myPdf = PdfDocument.renderHtmlAsPdf(" ~Hello World~  Made with IronPDF!");
   
          // Save the PdfDocument to a file
          myPdf.saveAs(Paths.get("html_saved.pdf"));
      }
   }

   import com.ironsoftware.ironpdf.*;
   import java.io.IOException;
   import java.nio.file.Paths;
   
   public class PdfExample {
      public static void main(String[] args) throws IOException {
          // Apply your license key 
          License.setLicenseKey("YOUR-LICENSE-KEY");
   
          // Set a log path 
          Settings.setLogPath(Paths.get("C:/tmp/IronPdfEngine.log"));
   
          // Render the HTML as a PDF, stored in myPdf as type PdfDocument
          PdfDocument myPdf = PdfDocument.renderHtmlAsPdf(" ~Hello World~  Made with IronPDF!");
   
          // Save the PdfDocument to a file
          myPdf.saveAs(Paths.get("html_saved.pdf"));
      }
   }

   JAVA

Note that IronPDF uses a proprietary HTML-to-PDF conversion engine and does not rely on external tools like wkhtmltopdf. Developers can also fine-tune output quality with margins, headers, DPI, and other rendering options.

The following table summarizes the key differences between the two libraries at a glance.

For teams evaluating IronPDF as a wkhtmltopdf replacement on Windows, a free 30-day trial is available with no credit card required.

Manipulating PDF files with IronPDF

IronPDF is a C# library that can be used to create, manipulate, and render PDF documents. It provides an easy-to-use API that allows developers to perform various operations on PDF files, such as adding text, images, and tables, as well as merging, splitting, and converting PDF files. Here is an example of how to use IronPDF to add text to a PDF file:

using IronPdf;

var Renderer = new ChromePdfRenderer();
// Render a local HTML file as PDF
using var PDF = Renderer.RenderHtmlFileAsPdf("Project/MyHtmlDocument.html");
// Save the PDF to disk
PDF.SaveAs("Project/MyOutput.pdf");

using IronPdf;

var Renderer = new ChromePdfRenderer();
// Render a local HTML file as PDF
using var PDF = Renderer.RenderHtmlFileAsPdf("Project/MyHtmlDocument.html");
// Save the PDF to disk
PDF.SaveAs("Project/MyOutput.pdf");

Manipulating PDF files with wkhtmltopdf

wkhtmltopdf is a command-line tool that converts HTML pages to PDF files. It uses the Qt WebKit rendering engine to render HTML to PDF format. Note that Qt WebKit is no longer actively maintained, so its support for modern HTML5, CSS3, and JavaScript features has not kept pace with Chromium-based engines.

using System.Text;
using System.Diagnostics;

class PdfGenerator
{
    static void Main(string[] args)
    {
        // Function to convert HTML to PDF using wkhtmltopdf
        ConvertHtmlToPdf("URL", "Sample.pdf");
        Console.WriteLine("PDF successfully created!");
        Console.ReadKey();
    }

    // Function to configure and start the wkhtmltopdf process
    public static void ConvertHtmlToPdf(string url, string filename)
    {
        // Construct the command line parameters
        StringBuilder paramsBuilder = new StringBuilder();
        paramsBuilder.AppendFormat("\"{0}\" \"{1}\"", url, filename);

        // Create and configure the process
        using (Process process = new Process())
        {
            // Specify the path to wkhtmltopdf executable
            process.StartInfo.FileName = "C:\\Program Files (x86)\\wkhtmltopdf\\bin\\wkhtmltopdf.exe";
            process.StartInfo.Arguments = paramsBuilder.ToString();

            // Configure process settings
            process.StartInfo.UseShellExecute = false;
            process.StartInfo.RedirectStandardOutput = true;
            process.StartInfo.RedirectStandardError = true;

            // Start the process and wait for it to exit
            process.Start();
            if (!process.WaitForExit(60000))
            {
                process.Kill();
                Console.WriteLine("Process terminated as it exceeded the time limit.");
            }
        }
    }
}

using System.Text;
using System.Diagnostics;

class PdfGenerator
{
    static void Main(string[] args)
    {
        // Function to convert HTML to PDF using wkhtmltopdf
        ConvertHtmlToPdf("URL", "Sample.pdf");
        Console.WriteLine("PDF successfully created!");
        Console.ReadKey();
    }

    // Function to configure and start the wkhtmltopdf process
    public static void ConvertHtmlToPdf(string url, string filename)
    {
        // Construct the command line parameters
        StringBuilder paramsBuilder = new StringBuilder();
        paramsBuilder.AppendFormat("\"{0}\" \"{1}\"", url, filename);

        // Create and configure the process
        using (Process process = new Process())
        {
            // Specify the path to wkhtmltopdf executable
            process.StartInfo.FileName = "C:\\Program Files (x86)\\wkhtmltopdf\\bin\\wkhtmltopdf.exe";
            process.StartInfo.Arguments = paramsBuilder.ToString();

            // Configure process settings
            process.StartInfo.UseShellExecute = false;
            process.StartInfo.RedirectStandardOutput = true;
            process.StartInfo.RedirectStandardError = true;

            // Start the process and wait for it to exit
            process.Start();
            if (!process.WaitForExit(60000))
            {
                process.Kill();
                Console.WriteLine("Process terminated as it exceeded the time limit.");
            }
        }
    }
}

In summary, IronPDF and wkhtmltopdf are two powerful tools that can be used to manipulate PDF files in C#. IronPDF provides an easy-to-use API for creating, manipulating, and rendering PDF files, while wkhtmltopdf is a command-line tool that can be used to convert HTML pages to PDF files. Both tools have their own strengths and weaknesses, and developers should choose the one that best suits their needs.

How Do wkhtmltopdf and IronPDF Compare?

IronPDF: Full Bootstrap Support

IronPDF's Chromium rendering engine provides complete support for modern CSS frameworks:

• Bootstrap 5: Full flexbox and CSS Grid support for responsive layouts
• Complex layouts: Renders the Bootstrap homepage and Bootstrap templates pixel-perfect
• Modern features: CSS3 animations, transforms, transitions, and media queries
• CSS frameworks: Bootstrap, Tailwind CSS, Foundation, Bulma all work seamlessly

Code Example: Rendering Bootstrap Content

using IronPdf;

// Render a Bootstrap 5 layout
var renderer = new ChromePdfRenderer();

// Example: Bootstrap navigation and card layout
string bootstrapHtml = @"
<!DOCTYPE html>
<html>
<head>
    <link href='https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/css/bootstrap.min.css' rel='stylesheet'>
</head>
<body>
    <nav class='navbar navbar-expand-lg navbar-dark bg-primary'>
        <div class='container'>
            <a class='navbar-brand' href='#'>My Company</a>
        </div>
    </nav>

    <div class='container mt-4'>
        <div class='row'>
            <div class='col-md-4'>
                <div class='card'>
                    <div class='card-body'>
                        <h5 class='card-title'>Feature 1</h5>
                        <p class='card-text'>Modern flexbox-based layout.</p>
                    </div>
                </div>
            </div>
            <div class='col-md-4'>
                <div class='card'>
                    <div class='card-body'>
                        <h5 class='card-title'>Feature 2</h5>
                        <p class='card-text'>Responsive grid system.</p>
                    </div>
                </div>
            </div>
            <div class='col-md-4'>
                <div class='card'>
                    <div class='card-body'>
                        <h5 class='card-title'>Feature 3</h5>
                        <p class='card-text'>CSS3 animations supported.</p>
                    </div>
                </div>
            </div>
        </div>
    </div>
</body>
</html>";

var pdf = renderer.RenderHtmlAsPdf(bootstrapHtml);
pdf.SaveAs("bootstrap-layout.pdf");

using IronPdf;

// Render a Bootstrap 5 layout
var renderer = new ChromePdfRenderer();

// Example: Bootstrap navigation and card layout
string bootstrapHtml = @"
<!DOCTYPE html>
<html>
<head>
    <link href='https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/css/bootstrap.min.css' rel='stylesheet'>
</head>
<body>
    <nav class='navbar navbar-expand-lg navbar-dark bg-primary'>
        <div class='container'>
            <a class='navbar-brand' href='#'>My Company</a>
        </div>
    </nav>

    <div class='container mt-4'>
        <div class='row'>
            <div class='col-md-4'>
                <div class='card'>
                    <div class='card-body'>
                        <h5 class='card-title'>Feature 1</h5>
                        <p class='card-text'>Modern flexbox-based layout.</p>
                    </div>
                </div>
            </div>
            <div class='col-md-4'>
                <div class='card'>
                    <div class='card-body'>
                        <h5 class='card-title'>Feature 2</h5>
                        <p class='card-text'>Responsive grid system.</p>
                    </div>
                </div>
            </div>
            <div class='col-md-4'>
                <div class='card'>
                    <div class='card-body'>
                        <h5 class='card-title'>Feature 3</h5>
                        <p class='card-text'>CSS3 animations supported.</p>
                    </div>
                </div>
            </div>
        </div>
    </div>
</body>
</html>";

var pdf = renderer.RenderHtmlAsPdf(bootstrapHtml);
pdf.SaveAs("bootstrap-layout.pdf");

The above code renders perfectly with IronPDF, preserving all Bootstrap styling, flexbox layouts, and responsive grid systems.

wkhtmltopdf: Narrower CSS Framework Support

wkhtmltopdf's Qt WebKit engine was not designed for the CSS specifications that modern frameworks rely on:

• Flexbox gaps: Bootstrap 4+ relies heavily on flexbox, which Qt WebKit's engine does not fully support
• CSS Grid not supported: Modern grid layouts are outside Qt WebKit's rendering capabilities
• Engine age: Qt WebKit was last updated in 2016, so modern CSS3 features such as clamp(), aspect-ratio, and container queries are outside its supported scope
• Workarounds required: Developers must use older Bootstrap versions (Bootstrap 3 or earlier) or implement table-based fallbacks

For more details on CSS framework support and troubleshooting flexbox/Bootstrap rendering issues, see the Bootstrap & Flexbox CSS Guide.