Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

MhtmlPdfConverterExtensions

OfficeIMO.Mhtml

Namespace
OfficeIMO.Mhtml
Assembly
OfficeIMO.Mhtml.Pdf
Source revision
0eef6a5756b9 with working tree changes
Modifiers
static

Converts bounded MHTML archives to the first-party OfficeIMO PDF model.

Inheritance

  • object
  • MhtmlPdfConverterExtensions

Methods

public static async Task<PdfDocumentConversionResult> RenderToPdfDocumentResultAsync(MhtmlDocument document, HtmlRenderRequest request, CancellationToken cancellationToken = default) #

Renders an explicit PDF intent using the archive's embedded resources and returns conversion diagnostics.

Parameters

document OfficeIMO.Mhtml.MhtmlDocument required
request OfficeIMO.Html.HtmlRenderRequest required
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<PdfDocumentConversionResult>
SaveAsPdf 2 overloads
public static OfficeConversionReport SaveAsPdf(MhtmlDocument document, string path, HtmlPdfExportOptions? options = null, CancellationToken cancellationToken = default) #

Writes the MHTML archive as a PDF file and returns the complete conversion report.

Parameters

document OfficeIMO.Mhtml.MhtmlDocument required
path string required
options OfficeIMO.Html.Pdf.HtmlPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public static OfficeConversionReport SaveAsPdf(MhtmlDocument document, Stream stream, HtmlPdfExportOptions? options = null, CancellationToken cancellationToken = default) #

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

Parameters

document OfficeIMO.Mhtml.MhtmlDocument 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(MhtmlDocument document, string path, HtmlPdfExportOptions? options = null, CancellationToken cancellationToken = default) #

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

Parameters

document OfficeIMO.Mhtml.MhtmlDocument 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(MhtmlDocument document, Stream stream, HtmlPdfExportOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously writes the MHTML archive as PDF to a caller-owned stream and returns the complete conversion report.

Parameters

document OfficeIMO.Mhtml.MhtmlDocument 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(MhtmlDocument document, HtmlPdfExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts the MHTML archive to a PDF model.

Parameters

document OfficeIMO.Mhtml.MhtmlDocument required
options OfficeIMO.Html.Pdf.HtmlPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

PdfDocument
public static PdfDocument ToPdf(MhtmlDocument document, HtmlPdfExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #

Converts the MHTML archive and returns its completed conversion findings.

Parameters

document OfficeIMO.Mhtml.MhtmlDocument 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(MhtmlDocument document, HtmlPdfExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts the MHTML archive, returning the model and report together.

Parameters

document OfficeIMO.Mhtml.MhtmlDocument required
options OfficeIMO.Html.Pdf.HtmlPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<PdfDocument>>