# HtmlPdfConverterExtensions

Converts a parsed OfficeIMO HTML source document through the shared HTML render scene.

Class 

`OfficeIMO.Html.Pdf`

**Namespace**

`OfficeIMO.Html.Pdf`

**Assembly**

`OfficeIMO.Html.Pdf`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[HtmlPdfConverterExtensions.Requests.cs:12](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Html.Pdf/HtmlToPdf/HtmlPdfConverterExtensions.Requests.cs#L12)

**Modifiers**

static

Converts a parsed OfficeIMO HTML source document through the shared HTML render scene.

## Inheritance

- object
- HtmlPdfConverterExtensions

Filter members 

Show inherited

## Methods

`public static byte[] RenderToPdfBytes(HtmlConversionDocument document, HtmlRenderRequest request, CancellationToken cancellationToken = default)` [#](#method-rendertopdfbytes-officeimo-html-htmlconversiondocument-officeimo-html-htmlrenderrequest-threading-cancellationtoken)

[HtmlPdfConverterExtensions.Requests.cs:12](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Html.Pdf/HtmlToPdf/HtmlPdfConverterExtensions.Requests.cs#L12)

Executes an explicit PDF render request and serializes the resulting document.

Parameters

**document OfficeIMO.Html.HtmlConversionDocument required**

**request OfficeIMO.Html.HtmlRenderRequest required**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`byte[]`

`public static async Task<byte[]> RenderToPdfBytesAsync(HtmlConversionDocument document, HtmlRenderRequest request, CancellationToken cancellationToken = default)` [#](#method-rendertopdfbytesasync-officeimo-html-htmlconversiondocument-officeimo-html-htmlrenderrequest-threading-cancellationtoken)

Executes an explicit PDF render request and asynchronously serializes the result.

Parameters

**document OfficeIMO.Html.HtmlConversionDocument required**

**request OfficeIMO.Html.HtmlRenderRequest required**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<byte[]>`

`public static PdfDocumentConversionResult RenderToPdfDocumentResult(HtmlConversionDocument document, HtmlRenderRequest request, CancellationToken cancellationToken = default)` [#](#method-rendertopdfdocumentresult-officeimo-html-htmlconversiondocument-officeimo-html-htmlrenderrequest-threading-cancellationtoken)

[HtmlPdfConverterExtensions.Requests.cs:58](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Html.Pdf/HtmlToPdf/HtmlPdfConverterExtensions.Requests.cs#L58)

Executes an explicit PDF render request and returns the PDF plus its conversion report.

Parameters

**document OfficeIMO.Html.HtmlConversionDocument required**

**request OfficeIMO.Html.HtmlRenderRequest required**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`PdfDocumentConversionResult`

`public static async Task<PdfDocumentConversionResult> RenderToPdfDocumentResultAsync(HtmlConversionDocument document, HtmlRenderRequest request, CancellationToken cancellationToken = default)` [#](#method-rendertopdfdocumentresultasync-officeimo-html-htmlconversiondocument-officeimo-html-htmlrenderrequest-threading-cancellationtoken)

Asynchronously executes an explicit PDF render request and returns the PDF plus its conversion report.

Parameters

**document OfficeIMO.Html.HtmlConversionDocument required**

**request OfficeIMO.Html.HtmlRenderRequest required**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<PdfDocumentConversionResult>`

`public static HtmlPdfRenderRequestResult RenderToPdfResult(HtmlConversionDocument document, HtmlRenderRequest request, CancellationToken cancellationToken = default)` [#](#method-rendertopdfresult-officeimo-html-htmlconversiondocument-officeimo-html-htmlrenderrequest-threading-cancellationtoken)

[HtmlPdfConverterExtensions.Requests.cs:34](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Html.Pdf/HtmlToPdf/HtmlPdfConverterExtensions.Requests.cs#L34)

Executes an explicit request and returns its retained surfaces together with the PDF output.

Parameters

**document OfficeIMO.Html.HtmlConversionDocument required**

**request OfficeIMO.Html.HtmlRenderRequest required**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`HtmlPdfRenderRequestResult`

`public static async Task<HtmlPdfRenderRequestResult> RenderToPdfResultAsync(HtmlConversionDocument document, HtmlRenderRequest request, CancellationToken cancellationToken = default)` [#](#method-rendertopdfresultasync-officeimo-html-htmlconversiondocument-officeimo-html-htmlrenderrequest-threading-cancellationtoken)

Asynchronously executes an explicit request and returns its retained surfaces with the PDF output.

Parameters

**document OfficeIMO.Html.HtmlConversionDocument required**

**request OfficeIMO.Html.HtmlRenderRequest required**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<HtmlPdfRenderRequestResult>`

SaveAsPdf 2 overloads

`public static OfficeConversionReport SaveAsPdf(HtmlConversionDocument document, string path, HtmlPdfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveaspdf-officeimo-html-htmlconversiondocument-string-officeimo-html-pdf-htmlpdfexportoptions-threading-cancellationtoken)

[HtmlPdfConverterExtensions.Save.cs:42](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Html.Pdf/HtmlToPdf/HtmlPdfConverterExtensions.Save.cs#L42)

Writes a PDF file and returns the complete conversion report.

Parameters

**document OfficeIMO.Html.HtmlConversionDocument required**

**path string required**

**options OfficeIMO.Html.Pdf.HtmlPdfExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`OfficeConversionReport`

`public static OfficeConversionReport SaveAsPdf(HtmlConversionDocument document, Stream stream, HtmlPdfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveaspdf-officeimo-html-htmlconversiondocument-io-stream-officeimo-html-pdf-htmlpdfexportoptions-threading-cancellationtoken)

[HtmlPdfConverterExtensions.Save.cs:58](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Html.Pdf/HtmlToPdf/HtmlPdfConverterExtensions.Save.cs#L58)

Writes PDF to a caller-owned stream and returns the complete conversion report.

Parameters

**document OfficeIMO.Html.HtmlConversionDocument required**

**stream System.IO.Stream required**

**options OfficeIMO.Html.Pdf.HtmlPdfExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`OfficeConversionReport`

SaveAsPdfAsync 2 overloads

`public static async Task<OfficeConversionReport> SaveAsPdfAsync(HtmlConversionDocument document, string path, HtmlPdfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveaspdfasync-officeimo-html-htmlconversiondocument-string-officeimo-html-pdf-htmlpdfexportoptions-threading-cancellationtoken)

Asynchronously writes a PDF file and returns the complete conversion report.

Parameters

**document OfficeIMO.Html.HtmlConversionDocument required**

**path string required**

**options OfficeIMO.Html.Pdf.HtmlPdfExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<OfficeConversionReport>`

`public static async Task<OfficeConversionReport> SaveAsPdfAsync(HtmlConversionDocument document, Stream stream, HtmlPdfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveaspdfasync-officeimo-html-htmlconversiondocument-io-stream-officeimo-html-pdf-htmlpdfexportoptions-threading-cancellationtoken)

Asynchronously writes PDF to a caller-owned stream and returns its conversion report.

Parameters

**document OfficeIMO.Html.HtmlConversionDocument required**

**stream System.IO.Stream required**

**options OfficeIMO.Html.Pdf.HtmlPdfExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<OfficeConversionReport>`

ToPdf 2 overloads

`public static PdfDocument ToPdf(HtmlConversionDocument document, HtmlPdfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-topdf-officeimo-html-htmlconversiondocument-officeimo-html-pdf-htmlpdfexportoptions-threading-cancellationtoken)

[HtmlPdfConverterExtensions.Save.cs:10](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Html.Pdf/HtmlToPdf/HtmlPdfConverterExtensions.Save.cs#L10)

Converts the source document to a PDF model.

Parameters

**document OfficeIMO.Html.HtmlConversionDocument required**

**options OfficeIMO.Html.Pdf.HtmlPdfExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`PdfDocument`

`public static PdfDocument ToPdf(HtmlConversionDocument document, HtmlPdfExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default)` [#](#method-topdf-officeimo-html-htmlconversiondocument-officeimo-html-pdf-htmlpdfexportoptions-officeimo-officeconversionreport-threading-cancellationtoken)

[HtmlPdfConverterExtensions.Save.cs:15](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Html.Pdf/HtmlToPdf/HtmlPdfConverterExtensions.Save.cs#L15)

Converts the source document and returns its completed conversion findings.

Parameters

**document OfficeIMO.Html.HtmlConversionDocument required**

**options OfficeIMO.Html.Pdf.HtmlPdfExportOptions? required**

**report OfficeIMO.OfficeConversionReport required**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`PdfDocument`

`public static async Task<OfficeConversionResult<PdfDocument>> ToPdfAsync(HtmlConversionDocument document, HtmlPdfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-topdfasync-officeimo-html-htmlconversiondocument-officeimo-html-pdf-htmlpdfexportoptions-threading-cancellationtoken)

Resolves resources asynchronously and returns the PDF model and completed conversion report.

Parameters

**document OfficeIMO.Html.HtmlConversionDocument required**

**options OfficeIMO.Html.Pdf.HtmlPdfExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<OfficeConversionResult<PdfDocument>>`

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

<!-- PowerForge markdown artifact sha256:7FB3C8E799CEB77003BD405935180C8023005B2A1AEF2C5F7815FC30E87D8730 -->
