HTML to Image .NET Examples

This page contains various examples of using the HTML to Image API in .NET. The examples are complete and fully functional. Read more about how to convert HTML to Image in .NET.

Basic examples
Template rendering examples

Basic examples

Convert a web page to a PNG file

using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // create the API client instance
            pdfcrowd.HtmlToImageClient client =
                new pdfcrowd.HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.setOutputFormat("png");

            // run the conversion and write the result to a file
            client.convertUrlToFile("http://www.example.com", "example.png");
        }
        catch(pdfcrowd.Error why)
        {
            // report the error
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw;
        }
    }
}

Convert a web page to in-memory PNG

using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // create the API client instance
            pdfcrowd.HtmlToImageClient client =
                new pdfcrowd.HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.setOutputFormat("png");

            // run the conversion and store the result into the "image" variable
            byte[] image = client.convertUrl("http://www.example.com");

            // at this point the "image" variable contains PNG raw data and
            // can be sent in an HTTP response, saved to a file, etc.
        }
        catch(pdfcrowd.Error why)
        {
            // report the error
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw;
        }
    }
}

Convert a web page and write the resulting PNG to an output stream

using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // create the API client instance
            pdfcrowd.HtmlToImageClient client =
                new pdfcrowd.HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.setOutputFormat("png");

            // create an output stream for the conversion result
            FileStream outputStream = new FileStream("example.png", FileMode.CreateNew);

            // run the conversion and write the result into the output stream
            client.convertUrlToStream("http://www.example.com", outputStream);

            // close the output stream
            outputStream.Close();
        }
        catch(pdfcrowd.Error why)
        {
            // report the error
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw;
        }
    }
}

Convert a local HTML file to a PNG file

using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // create the API client instance
            pdfcrowd.HtmlToImageClient client =
                new pdfcrowd.HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.setOutputFormat("png");

            // run the conversion and write the result to a file
            client.convertFileToFile("/path/to/MyLayout.html", "MyLayout.png");
        }
        catch(pdfcrowd.Error why)
        {
            // report the error
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw;
        }
    }
}

Convert a local HTML file to in-memory PNG

using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // create the API client instance
            pdfcrowd.HtmlToImageClient client =
                new pdfcrowd.HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.setOutputFormat("png");

            // run the conversion and store the result into the "image" variable
            byte[] image = client.convertFile("/path/to/MyLayout.html");

            // at this point the "image" variable contains PNG raw data and
            // can be sent in an HTTP response, saved to a file, etc.
        }
        catch(pdfcrowd.Error why)
        {
            // report the error
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw;
        }
    }
}

Convert a local HTML file and write the resulting PNG to an output stream

using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // create the API client instance
            pdfcrowd.HtmlToImageClient client =
                new pdfcrowd.HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.setOutputFormat("png");

            // create an output stream for the conversion result
            FileStream outputStream = new FileStream("MyLayout.png", FileMode.CreateNew);

            // run the conversion and write the result into the output stream
            client.convertFileToStream("/path/to/MyLayout.html", outputStream);

            // close the output stream
            outputStream.Close();
        }
        catch(pdfcrowd.Error why)
        {
            // report the error
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw;
        }
    }
}

Convert a string containing HTML to a PNG file

using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // create the API client instance
            pdfcrowd.HtmlToImageClient client =
                new pdfcrowd.HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.setOutputFormat("png");

            // run the conversion and write the result to a file
            client.convertStringToFile("<html><body><h1>Hello World!</h1></body></html>", "HelloWorld.png");
        }
        catch(pdfcrowd.Error why)
        {
            // report the error
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw;
        }
    }
}

Convert a string containing HTML to in-memory PNG

using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // create the API client instance
            pdfcrowd.HtmlToImageClient client =
                new pdfcrowd.HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.setOutputFormat("png");

            // run the conversion and store the result into the "image" variable
            byte[] image = client.convertString("<html><body><h1>Hello World!</h1></body></html>");

            // at this point the "image" variable contains PNG raw data and
            // can be sent in an HTTP response, saved to a file, etc.
        }
        catch(pdfcrowd.Error why)
        {
            // report the error
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw;
        }
    }
}

Convert a string containing HTML and write the resulting PNG to an output stream

using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // create the API client instance
            pdfcrowd.HtmlToImageClient client =
                new pdfcrowd.HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.setOutputFormat("png");

            // create an output stream for the conversion result
            FileStream outputStream = new FileStream("HelloWorld.png", FileMode.CreateNew);

            // run the conversion and write the result into the output stream
            client.convertStringToStream("<html><body><h1>Hello World!</h1></body></html>", outputStream);

            // close the output stream
            outputStream.Close();
        }
        catch(pdfcrowd.Error why)
        {
            // report the error
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw;
        }
    }
}

Get info about the current conversion

using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // create the API client instance
            pdfcrowd.HtmlToImageClient client =
                new pdfcrowd.HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.setOutputFormat("png");
            client.setDebugLog(true);

            // run the conversion and write the result to a file
            client.convertFileToFile("/path/to/MyLayout.html", "MyLayout.png");
            
            // print URL to the debug log
            System.Console.WriteLine("Debug log url: " + client.getDebugLogUrl());
            
            // print the number of available conversion credits in your account
            System.Console.WriteLine("Remaining credit count: " + client.getRemainingCreditCount());
            
            // print the number of credits consumed by the conversion
            System.Console.WriteLine("Consumed credit count: " + client.getConsumedCreditCount());
            
            // print the unique ID of the conversion
            System.Console.WriteLine("Job id: " + client.getJobId());
            
            // print the size of the output in bytes
            System.Console.WriteLine("Output size: " + client.getOutputSize());
        }
        catch(pdfcrowd.Error why)
        {
            // report the error
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw;
        }
    }
}

Advanced examples

Template rendering Examples

Create Image from JSON data

using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // create the API client instance
            pdfcrowd.HtmlToPdfClient client =
                new pdfcrowd.HtmlToPdfClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.setDataString(@"{
            ""name"": ""World"",
            ""product"": ""Pdfcrowd API""
        }");

            // run the conversion and write the result to a file
            client.convertStringToFile("Hello {{ name }} from {{ product }}", "output.pdf");
        }
        catch(pdfcrowd.Error why)
        {
            // report the error
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw;
        }
    }
}

Create Image from XML data

using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // create the API client instance
            pdfcrowd.HtmlToPdfClient client =
                new pdfcrowd.HtmlToPdfClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.setDataString(@"<?xml version=""1.0"" encoding=""UTF-8""?>
        <data>
          <name>World</name>
          <product>Pdfcrowd API</product>
        </data>");

            // run the conversion and write the result to a file
            client.convertStringToFile("Hello {{ data.name }} from {{ data.product }}", "output.pdf");
        }
        catch(pdfcrowd.Error why)
        {
            // report the error
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw;
        }
    }
}

Create Image from YAML data

using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // create the API client instance
            pdfcrowd.HtmlToPdfClient client =
                new pdfcrowd.HtmlToPdfClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.setDataString(@"name: World
product: Pdfcrowd API");

            // run the conversion and write the result to a file
            client.convertStringToFile("Hello {{ name }} from {{ product }}", "output.pdf");
        }
        catch(pdfcrowd.Error why)
        {
            // report the error
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw;
        }
    }
}

Create Image from CSV data

using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // create the API client instance
            pdfcrowd.HtmlToPdfClient client =
                new pdfcrowd.HtmlToPdfClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.setDataString(@"name,product
World,Pdfcrowd API");

            // run the conversion and write the result to a file
            client.convertStringToFile("Hello {{ name }} from {{ product }}", "output.pdf");
        }
        catch(pdfcrowd.Error why)
        {
            // report the error
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

            // rethrow or handle the exception
            throw;
        }
    }
}