Shark.PdfConvert 1.0.5

.NET Standard 1.6 This package targets .NET Standard 1.6. The package is compatible with this framework or higher. .NET Framework 4.5.1 This package targets .NET Framework 4.5.1. The package is compatible with this framework or higher. 
dotnet add package Shark.PdfConvert --version 1.0.5                

                    
                

            
NuGet\Install-Package Shark.PdfConvert -Version 1.0.5
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="Shark.PdfConvert" Version="1.0.5" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Shark.PdfConvert --version 1.0.5                

                    
                

            
#r "nuget: Shark.PdfConvert, 1.0.5"
#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 Shark.PdfConvert as a Cake Addin
#addin nuget:?package=Shark.PdfConvert&version=1.0.5

// Install Shark.PdfConvert as a Cake Tool
#tool nuget:?package=Shark.PdfConvert&version=1.0.5

Shark.PdfConvert

What is Shark.PdfConvert?

Shark.PdfConvert is a simple .NET Core (also targets net451) wrapper around the WkHtmlToPdf tool. Most options are exposed via a PdfConversionSettings object, others can be specified by using Custom overrides for the configuration area you want.

Conversion setting defaults are set for a Windows environment and assume you have the WkHTMLToPDF (x64) tool installed. You can override the Path to the tool by overridding PdfConversionSettings . PdfToolPath.

You will need to install/download WkHtmlToPdf, it is not embedded in the NuGet Package

Sample 1: Static HTML Content

PdfConvert.Convert(new PdfConversionSettings
{
    Title = "My Static Content",
    Content = @"<h1>Lorem ipsum dolor sit amet consectetuer adipiscing elit 
	    I SHOULD BE RED BY JAVASCRIPT</h1>
		<script>document.querySelector('h1').style.color = 'rgb(128,0,0)';</script>",
    OutputPath = @"C:\temp\temp.pdf"
});

Sample 2: Get Content from a URL

PdfConvert.Convert(new PdfConversionSettings
{
    Title = "My URL based Content",
    ContentUrl = "http://www.lipsum.com/",
    OutputPath = @"C:\temp\temp-url.pdf"
});

Sample 3: Use Streams for Output and Input

PdfConversionSettings config = new PdfConversionSettings
{
    Title = "Streaming my HTML to PDF"
};

using (var fileStream = new FileStream(Path.GetTempFileName() + ".pdf", FileMode.Create))
{
    var task = new System.Net.Http.HttpClient().GetStreamAsync("http://www.google.com");
    task.Wait();

    using (var inputStream = task.Result)
    {
		PdfConvert.Convert(config, fileStream, inputStream);
	}
}

Sample 4: Mix and Match

PdfConversionSettings config = new PdfConversionSettings
{
    Title = "A little bit of Everything",
    GenerateToc = true,
    TocHeaderText = "Table of MY Contents",
    PageCoverUrl = "https://blackrockdigital.github.io/startbootstrap-landing-page/",
    ContentUrl = "http://www.lipsum.com/",
    PageHeaderHtml = @"
        <!DOCTYPE html>
        <html><body>
        <div style=""background-color: red; color: white; text-align: center; width: 100vw;"">SECRET SAUCE</div>
        </body></html>"
};

using (var fileStream = new FileStream(Path.GetTempFileName() + ".pdf", FileMode.Create))
{
    PdfConvert.Convert(config, fileStream);
}

Sample 5: Usage inside MVC Controller Action

public IActionResult ConvertToPdf([FromBody] PdfConversionSettings model) 
{
	// TAKE CARE WHEN Accepting the Conversion Settings from user land, it would be best 
	// to just NOT DO it, accept your own custom model and map the parameters as needed.
	// If you insist, then you could do something like the following to prevent malicious code execution
	// in my testing the Custom*Args members are not a valid attack vector, PdfToolPath certainly is, never* trust
	// the client
#if DEBUG
    // set path to executable, UNSAFE DEBUG USE ONLY FOR TESTING
    model.PdfToolPath = model.PdfToolPath ?? _host.ContentRootPath + @"\wkhtmltopdf.exe";
#else
    // set path to executable
    model.PdfToolPath = _host.ContentRootPath + @"\wkhtmltopdf.exe";
#endif	  

    if (model.OutputFilename.EndsWith(".pdf") == false) model.OutputFilename = model.OutputFilename + ".pdf";

    var memoryStream = new MemoryStream();
    PdfConvert.Convert(model, memoryStream);
    return new FileContentResult(memoryStream.ToArray(), MimeTypes.Pdf)
    {
        FileDownloadName = model.OutputFileName
    };
}

Sample 6: Get Content from multiple URLs

var settings = new PdfConversionSettings
{
    Title = "My Content from multiple URLs",
    OutputPath = @"C:\temp\temp-url-multiple.pdf"
};
settings.ContentUrls.Add("http://www.lipsum.com/");
settings.ContentUrls.Add("http://www.google.com/");

PdfConvert.Convert(settings);

Sample 7: Zoom and Page Size (Issue #5)

PdfConvert.Convert(new PdfConversionSettings
{
    Title = "Converted by Shark.PdfConvert",
    LowQuality = false,
    Margins = new PdfPageMargins() { Bottom = 10, Left = 10, Right = 10, Top = 10 },
    Size = PdfPageSize.A3,
    Zoom = 3.2f,
    Content = @"<h1>Lorem ipsum dolor sit amet consectetuer adipiscing elit I SHOULD BE RED BY JAVASCRIPT</h1><script>document.querySelector('h1').style.color = 'rgb(128,0,0)';</script>",
    OutputPath = @"C:\temp\sample7.pdf"
});

Revision History*

  • 1.0.4 - Merged PRs from very patient PR submitters #16, #9, and #7
  • 1.0.3 - Fixed Issue #5 with Zoom / Page Size options and Fixed Header/Footer/Cover issues.
  • 1.0.2 - Added ContentUrls property to PdfConversionSettings to allow for multiple URLs to be specified. Requested via Issue.
  • 1.0.1 - Spoke to soon, updated the samples, they had a typo, small tweaks in the code, nothing breaking or signature modifying
  • 1.0.0 - Should be stable going forward except for any bugs found. Modified Convert method signature to be a bit more sane, Added additional static content options, Added Url overrides if you wanted to have WkHTMLToPDF grab external sites for any portion of the generated document, exposed some process options
  • 0.1.0 - Initial Upload
Product 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 netcoreapp1.0 was computed.  netcoreapp1.1 was computed.  netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard1.6 is compatible.  netstandard2.0 was computed.  netstandard2.1 was computed. 
.NET Framework net451 is compatible.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen30 was computed.  tizen40 was computed.  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.

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.0.5 172,410 11/6/2020
1.0.4 2,785 9/24/2020
1.0.3 71,920 6/7/2018
1.0.2 1,033 6/5/2018
1.0.1 3,907 2/21/2017

Version 1.0.5 - --quiet option
Version 1.0.4 - Merged PRs from very patient PR submitters
Version 1.0.3 - Fixing issues 2 and 5 (Zoom/Page/Header/Footer/Cover)
Version 1.0.2 - Added ContentUrls property to PdfConversionSettings to allow specifying multiple URLs
Version 1.0.1 - Fixed some minor issues with the tests