Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

MhtmlImageConversionExtensions

OfficeIMO.Mhtml

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

Renders MHTML through the existing PDF layout and shared image-export owners.

Inheritance

  • object
  • MhtmlImageConversionExtensions

Methods

public static OfficeConversionReport SaveAsImages(MhtmlDocument document, string folderPath, PdfImageExportOptions? imageOptions = null, HtmlPdfExportOptions? conversionOptions = null, CancellationToken cancellationToken = default) #

Saves selected pages using shared atomic image files, limits, and loss rejection.

Parameters

document OfficeIMO.Mhtml.MhtmlDocument required
folderPath string required
imageOptions OfficeIMO.Pdf.PdfImageExportOptions? = null optional
conversionOptions OfficeIMO.Html.Pdf.HtmlPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public static async Task<OfficeConversionReport> SaveAsImagesAsync(MhtmlDocument document, string folderPath, PdfImageExportOptions? imageOptions = null, HtmlPdfExportOptions? conversionOptions = null, CancellationToken cancellationToken = default) #

Saves selected pages asynchronously while releasing completed image payloads.

Parameters

document OfficeIMO.Mhtml.MhtmlDocument required
folderPath string required
imageOptions OfficeIMO.Pdf.PdfImageExportOptions? = null optional
conversionOptions OfficeIMO.Html.Pdf.HtmlPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
ToImages 3 overloads
public static IReadOnlyList<OfficeImageExportResult> ToImages(MhtmlDocument document, PdfImageExportOptions? imageOptions = null, HtmlPdfExportOptions? conversionOptions = null, CancellationToken cancellationToken = default) #

Renders selected pages, retaining MHTML conversion and PDF rendering diagnostics.

Parameters

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

Returns

IReadOnlyList<OfficeImageExportResult>
public static IReadOnlyList<OfficeImageExportResult> ToImages(MhtmlDocument document, OfficeImageExportFormat format, PdfImageExportOptions? imageOptions = null, HtmlPdfExportOptions? conversionOptions = null, CancellationToken cancellationToken = default) #

Renders selected pages with an explicit encoding.

Parameters

document OfficeIMO.Mhtml.MhtmlDocument required
format OfficeIMO.Drawing.OfficeImageExportFormat required
imageOptions OfficeIMO.Pdf.PdfImageExportOptions? = null optional
conversionOptions OfficeIMO.Html.Pdf.HtmlPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

IReadOnlyList<OfficeImageExportResult>
public static void ToImages(MhtmlDocument document, OfficeImageExportConsumer consumer, PdfImageExportOptions? imageOptions = null, HtmlPdfExportOptions? conversionOptions = null, CancellationToken cancellationToken = default) #

Streams selected pages without retaining earlier encoded payloads.

Parameters

document OfficeIMO.Mhtml.MhtmlDocument required
consumer OfficeIMO.Drawing.OfficeImageExportConsumer required
imageOptions OfficeIMO.Pdf.PdfImageExportOptions? = null optional
conversionOptions OfficeIMO.Html.Pdf.HtmlPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional
public static Task<IReadOnlyList<OfficeImageExportResult>> ToImagesAsync(MhtmlDocument document, PdfImageExportOptions? imageOptions = null, HtmlPdfExportOptions? conversionOptions = null, CancellationToken cancellationToken = default) #

Renders selected pages asynchronously under the shared deadline and cancellation policy.

Parameters

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

Returns

Task<IReadOnlyList<OfficeImageExportResult>>