Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

HtmlPdfConverterExtensions

OfficeIMO.Html.Pdf

Namespace
OfficeIMO.Html.Pdf
Assembly
OfficeIMO.Html.Pdf
Source revision
ba882f6b0d07 with working tree changes
Modifiers
static

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

Inheritance

  • object
  • HtmlPdfConverterExtensions

Methods

public static byte[] RenderToPdfBytes(HtmlConversionDocument document, HtmlRenderRequest request, CancellationToken cancellationToken = default) #

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) #

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) #

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) #

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) #

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
public static async Task<HtmlPdfRenderRequestResult> RenderToPdfResultAsync(HtmlConversionDocument document, HtmlRenderRequest request, CancellationToken cancellationToken = default) #

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
SaveAsPdf 2 overloads
public static OfficeConversionReport SaveAsPdf(HtmlConversionDocument document, string path, HtmlPdfExportOptions? options = null, CancellationToken cancellationToken = default) #

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) #

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) #

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) #

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) #

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) #

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) #

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>>