SolidCompany.Wrappers.WkHtmlToImage 1.4.1

.NET Standard 2.1
NuGet\Install-Package SolidCompany.Wrappers.WkHtmlToImage -Version 1.4.1
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.
dotnet add package SolidCompany.Wrappers.WkHtmlToImage --version 1.4.1
<PackageReference Include="SolidCompany.Wrappers.WkHtmlToImage" Version="1.4.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add SolidCompany.Wrappers.WkHtmlToImage --version 1.4.1
#r "nuget: SolidCompany.Wrappers.WkHtmlToImage, 1.4.1"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install SolidCompany.Wrappers.WkHtmlToImage as a Cake Addin
#addin nuget:?package=SolidCompany.Wrappers.WkHtmlToImage&version=1.4.1

// Install SolidCompany.Wrappers.WkHtmlToImage as a Cake Tool
#tool nuget:?package=SolidCompany.Wrappers.WkHtmlToImage&version=1.4.1

SolidCompany.Wrappers.WkHtmlToImage is a .NET Core wrapper for a part of an open-source project wkhtmltopdf which is wkhtmltoimage. It supports converting an HTML to images in a selected format.

Get Packages

You can get SolidCompany.Wrappers.WkHtmlToImage package by downloading it from NuGet feed.

Getting Started

SolidCompany.Wrappers.WkHtmlToImage easily integrates with .NET Core Dependency Injection. You need only one line of code to get everything working:

public void ConfigureServices(IServiceCollection services)
    // ...

    // ...

Now you are free to use this powerful tool by injecting IHtmlToImage into a constructor:

public class SampleService
    private readonly IHtmlToImage htmlToImage;

    public SampleService(IHtmlToImage htmlToImage)
        this.htmlToImage = htmlToImage;

    public async Task<Stream> ConvertHtmlToImageAsync(string html, int widthPx)
        return await htmlToImage.CreateImageAsync(html, widthPx, ImageFormat.Png);

Image height is automatically scaled to width which preserves a valid ratio.


You can pass a few additional options to configuration:

services.AddHtmlToImageConversion((serviceProvider, options) =>
    options.DependencyLogger = new ApplicationInsightsDependencyLogger(serviceProvider.GetRequiredService<TelemetryClient>());
    options.ExecutionTimeout = TimeSpan.FromMinutes(2);
    options.ExectuionDirectory = new CustomDirectory("C:/Temp");

DependencyLogger allows to track every wkhtmltoimage call with Azure Application Insights. To use it you need SolidCompany.Wrappers.Logging.ApplicationInsights package.

ExecutionTimeout lets you specify a maximum wkhtmltoimage execution time. Default is 30 seconds.

ExectuionDirectory specifies where the exe file is run and where temporary files are created. By default %TEMP%\SolidCompany.Wrappers.WkHtmlToImage directory is used.

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.1
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.4.1 1,383 9/21/2021
1.4.0 478 8/1/2021
1.3.12 211 6/28/2021
1.3.11 247 6/9/2021
1.3.7 218 5/9/2021
1.3.6 187 4/24/2021
1.3.5 243 4/18/2021
1.3.4 182 4/18/2021