HtmlToImage.ConvertHtmlStringAsync(String, CancellationToken) Method


HtmlToImageConvertHtmlStringAsync(String, CancellationToken) Method

Asynchronously converts the specified HTML string to an image in ImageFormat (PNG by default), stopping when the specified token is cancelled.

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

Syntax

Copy

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

Public Function ConvertHtmlStringAsync ( 
	htmlString As String,
	cancellationToken As CancellationToken
) As Task(Of Byte())

Parameters

htmlString String: The HTML markup to render.
cancellationToken CancellationToken: A token that stops the conversion when it is cancelled.

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.
OperationCanceledException	The task is cancelled when cancellationToken is cancelled before the conversion completes.

Remarks

The conversion produces the same image as ConvertHtmlString(String), without holding a thread while the HTML renders. Cancelling the token stops the conversion, and the task then ends cancelled.

Reference

HtmlToImage Class

ConvertHtmlStringAsync Overload

SelectPdf.Universal Namespace

HtmlToImageConvertHtmlStringAsync(String, CancellationToken) Method

Parameters

Return Value

Reference