OpexPDF 2.0.0

OpexPDF

This package allows you to easily use OpexPDF's HTML to PDF api in your application. With just one call to the api, you can transform the HTML code you supply to a PDF document.

Documentation & support

The full API reference documentation can be found here. If you encounter any issues while using this library or have any feature requests, feel free to contact us at support@opexpdf.com.

Getting started

1. Register an account at OpexPDF (free plans available), and create an API key to use in your application.

2. Install the standard Nuget package into your application.

   Package Manager : Install-Package OpexPDF -Version 2.0.0
   CLI : dotnet add package --version 2.0.0 OpexPDF
   

3. In your code, create a client.

   var client = new OpexPdfClient("PDF-00000000-0000-0000-0000-000000000000");
   

4. Call the api and save the results to a file.

   // prepare the request
   var conversionRequest = new HtmlConversionRequest() {
       BodyHtmlContent = "<h1>Hello world!</h1>",
       Options = new ConvertOptions() {
           MarginTop = 0,
           MarginBottom = 0,
           MarginLeft = 0,
           MarginRight = 0
       }
   };
   
   // convert the html to a pdf document, and save the document to a file
   using (var result = await client.ConvertHtmlAsync(conversionRequest)) 
   using (var fileStream = File.Create(@"output.pdf")) {
       result.Stream.CopyTo(fileStream);
   }
   

Dependency Injection support for .NET Core

To add support for Dependency Injection in .NET Core applications, please install the OpexPDF.Extensions.DependencyInjection package, and add the following in the ConfigureServices method of Startup.cs:

using OpexPDF;

services.AddOpexPdf(options => {
    options.ApiKey = "PDF-00000000-0000-0000-0000-000000000000";
});

After that, you can inject an OpexPdfClient instance in your constructors in the usual way.