Class HtmlToPdfBuilder

Namespace

SimpleSign.HtmlToPdf

Assembly

SimpleSign.HtmlToPdf.dll

Builder for configuring HTML-to-PDF conversion options. All methods return a new instance (immutable builder pattern).

public sealed class HtmlToPdfBuilder

Inheritance

object

HtmlToPdfBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Convert()

Converts the HTML to PDF and returns the PDF bytes.

public byte[] Convert()

Returns

byte[]

Convert(Stream)

Converts the HTML to PDF and writes to the output stream.

public void Convert(Stream outputStream)

Parameters

outputStream Stream

ConvertAsync(Stream, CancellationToken)

Converts the HTML to PDF and writes to the output stream asynchronously.

public Task ConvertAsync(Stream outputStream, CancellationToken cancellationToken = default)

Parameters

outputStream Stream

cancellationToken CancellationToken

Returns

Task

ConvertAsync(CancellationToken)

Converts the HTML to PDF asynchronously and returns the PDF bytes.

public Task<byte[]> ConvertAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<byte[]>

SaveTo(string)

Converts the HTML to PDF and saves to a file.

public void SaveTo(string filePath)

Parameters

filePath string

SaveToAsync(string, CancellationToken)

Converts the HTML to PDF and saves to a file asynchronously.

public Task SaveToAsync(string filePath, CancellationToken cancellationToken = default)

Parameters

filePath string

cancellationToken CancellationToken

Returns

Task

WithAuthor(string)

Sets the PDF document author metadata.

public HtmlToPdfBuilder WithAuthor(string author)

Parameters

author string

Returns

HtmlToPdfBuilder

WithFooter(string)

Sets a footer template. Supports {page}, {pages}, {title}, {date} placeholders.

public HtmlToPdfBuilder WithFooter(string template)

Parameters

template string

Returns

HtmlToPdfBuilder

WithHeader(string)

Sets a header template. Supports {page}, {pages}, {title}, {date} placeholders.

public HtmlToPdfBuilder WithHeader(string template)

Parameters

template string

Returns

HtmlToPdfBuilder

WithMargins(float)

Sets uniform margins (in points, 1pt = 1/72 inch).

public HtmlToPdfBuilder WithMargins(float all)

Parameters

all float

Returns

HtmlToPdfBuilder

WithMargins(float, float, float, float)

Sets margins individually (in points, 1pt = 1/72 inch).

public HtmlToPdfBuilder WithMargins(float top, float right, float bottom, float left)

Parameters

top float

right float

bottom float

left float

Returns

HtmlToPdfBuilder

WithPageOrientation(PageOrientation)

Sets the page orientation for the output PDF.

public HtmlToPdfBuilder WithPageOrientation(PageOrientation orientation)

Parameters

orientation PageOrientation

Returns

HtmlToPdfBuilder

WithPageSize(PageSize)

Sets the page size for the output PDF.

public HtmlToPdfBuilder WithPageSize(PageSize pageSize)

Parameters

pageSize PageSize

Returns

HtmlToPdfBuilder

WithStylesheet(string)

Adds a CSS stylesheet to apply during conversion.

public HtmlToPdfBuilder WithStylesheet(string css)

Parameters

css string

Returns

HtmlToPdfBuilder

WithTitle(string)

Sets the PDF document title metadata.

public HtmlToPdfBuilder WithTitle(string title)

Parameters

title string

Returns

HtmlToPdfBuilder