HtmlToImage.ConvertHtmlStringAsync(String) Method


HtmlToImageConvertHtmlStringAsync(String) Method

Asynchronously converts the specified HTML string to an image in ImageFormat (PNG by default).

Namespace: SelectPdf.Universal
Assembly: SelectPdf.Universal (in SelectPdf.Universal.dll) Version: 26.4

Syntax

Copy

public Task<byte[]> ConvertHtmlStringAsync(
	string htmlString
)

Public Function ConvertHtmlStringAsync ( 
	htmlString As String
) As Task(Of Byte())

Parameters

htmlString String: The HTML markup to render.

Return Value

TaskByte
A task that completes with the rendered image, encoded in ImageFormat.

Exceptions

Exception	Condition
HtmlToPdfException	The task faults with this exception when htmlString is null, or the conversion fails.

Remarks

The conversion produces the same image as ConvertHtmlString(String), without holding a thread while the HTML renders.

Example

Copy

SelectPdf.Universal.HtmlToImage converter = new SelectPdf.Universal.HtmlToImage();
byte[] png = await converter.ConvertHtmlStringAsync("<h1>Hello</h1>");

Dim converter As New SelectPdf.Universal.HtmlToImage()
Dim png As Byte() = Await converter.ConvertHtmlStringAsync("<h1>Hello</h1>")

Reference

HtmlToImage Class

ConvertHtmlStringAsync Overload

SelectPdf.Universal Namespace

HtmlToImageConvertHtmlStringAsync(String) Method

Parameters

Return Value

Reference