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
ASP.NET Web Forms examples

Basic examples

Webpage to 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)
        {
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);
            throw;
        }
    }
}

Webpage 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)
        {
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);
            throw;
        }
    }
}

Webpage to PNG 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)
        {
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);
            throw;
        }
    }
}

HTML file to 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)
        {
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);
            throw;
        }
    }
}

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)
        {
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);
            throw;
        }
    }
}

HTML file to PNG 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)
        {
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);
            throw;
        }
    }
}

HTML string to 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)
        {
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);
            throw;
        }
    }
}

HTML string 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)
        {
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);
            throw;
        }
    }
}

HTML string to PNG 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)
        {
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);
            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)
        {
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);
            throw;
        }
    }
}

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.HtmlToImageClient client =
                new pdfcrowd.HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.setOutputFormat("png");
            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)
        {
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);
            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.HtmlToImageClient client =
                new pdfcrowd.HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.setOutputFormat("png");
            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)
        {
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);
            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.HtmlToImageClient client =
                new pdfcrowd.HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.setOutputFormat("png");
            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)
        {
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);
            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.HtmlToImageClient client =
                new pdfcrowd.HtmlToImageClient("demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.setOutputFormat("png");
            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)
        {
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);
            throw;
        }
    }
}

ASP.NET Web Forms examples

Webpage to PNG in ASP.NET Web Forms

using System;
using System.IO;
using System.Web;
using System.Web.UI;
using System.Web.Mvc;

namespace PdfcrowdDemo
{
    public partial class Default: System.Web.UI.Page
    {
        protected override void Render(HtmlTextWriter writer)
        {
            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");

                // set HTTP response headers
                Response.ContentType = "image/png";
                Response.Headers.Add("Cache-Control", "max-age=0");
                Response.Headers.Add("Accept-Ranges", "none");
                Response.Headers.Add("Content-Disposition", "attachment; filename*=UTF-8''" + Uri.EscapeUriString("example.png"));

                // send the result in the HTTP response
                Response.OutputStream.Write(image, 0, image.Length);
                Response.Flush();
            }
            catch(pdfcrowd.Error why)
            {
                // send the error in the HTTP response
                Response.StatusCode = why.getCode();
                Response.StatusDescription = why.getMessage();
            }
        }
    }
}

HTML file to PNG in ASP.NET Web Forms

using System;
using System.IO;
using System.Web;
using System.Web.UI;
using System.Web.Mvc;

namespace PdfcrowdDemo
{
    public partial class Default: System.Web.UI.Page
    {
        protected override void Render(HtmlTextWriter writer)
        {
            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");

                // set HTTP response headers
                Response.ContentType = "image/png";
                Response.Headers.Add("Cache-Control", "max-age=0");
                Response.Headers.Add("Accept-Ranges", "none");
                Response.Headers.Add("Content-Disposition", "attachment; filename*=UTF-8''" + Uri.EscapeUriString("MyLayout.png"));

                // send the result in the HTTP response
                Response.OutputStream.Write(image, 0, image.Length);
                Response.Flush();
            }
            catch(pdfcrowd.Error why)
            {
                // send the error in the HTTP response
                Response.StatusCode = why.getCode();
                Response.StatusDescription = why.getMessage();
            }
        }
    }
}

HTML string to PNG in ASP.NET Web Forms

using System;
using System.IO;
using System.Web;
using System.Web.UI;
using System.Web.Mvc;

namespace PdfcrowdDemo
{
    public partial class Default: System.Web.UI.Page
    {
        protected override void Render(HtmlTextWriter writer)
        {
            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>");

                // set HTTP response headers
                Response.ContentType = "image/png";
                Response.Headers.Add("Cache-Control", "max-age=0");
                Response.Headers.Add("Accept-Ranges", "none");
                Response.Headers.Add("Content-Disposition", "attachment; filename*=UTF-8''" + Uri.EscapeUriString("HelloWorld.png"));

                // send the result in the HTTP response
                Response.OutputStream.Write(image, 0, image.Length);
                Response.Flush();
            }
            catch(pdfcrowd.Error why)
            {
                // send the error in the HTTP response
                Response.StatusCode = why.getCode();
                Response.StatusDescription = why.getMessage();
            }
        }
    }
}