Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 606 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/

API Reference

Class

PdfImageExportExtensions

Edit on GitHub
Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source revision 804a7612eee4 with working tree changes
Source PdfImageExportBuilder.cs:212
Modifiers static

Canonical PDF page image-export entry points.

Inheritance

  • Object
  • PdfImageExportExtensions

Methods

ExportImage 2 overloads
public static OfficeImageExportResult ExportImage(PdfReadPage page, OfficeImageExportFormat format, PdfImageExportOptions? options = null) #
PdfImageExportBuilder.cs:232
Returns: OfficeImageExportResult

Exports one loaded PDF page using the shared five-format result contract.

Parameters

page OfficeIMO.Pdf.PdfReadPage requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
options OfficeIMO.Pdf.PdfImageExportOptions? = null optionalposition: 2
public static OfficeImageExportResult ExportImage(PdfReadPage page, OfficeImageExportFormat format, PdfImageExportOptions? options, CancellationToken cancellationToken) #
PdfImageExportBuilder.cs:240
Returns: OfficeImageExportResult

Exports one loaded PDF page and observes cancellation throughout supported render stages.

Parameters

page OfficeIMO.Pdf.PdfReadPage requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
options OfficeIMO.Pdf.PdfImageExportOptions? requiredposition: 2
cancellationToken System.Threading.CancellationToken requiredposition: 3
ExportImages 3 overloads
public static IReadOnlyList<OfficeImageExportResult> ExportImages(PdfDocument document, OfficeImageExportFormat format, PdfImageExportOptions? options = null, PdfPageSelection? selection = null, CancellationToken cancellationToken = default) #
PdfImageExportBuilder.cs:212
Returns: IReadOnlyList<OfficeImageExportResult>

Exports pages from an authored or opened PDF document using the shared five-format result contract.

Parameters

document OfficeIMO.Pdf.PdfDocument requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
options OfficeIMO.Pdf.PdfImageExportOptions? = null optionalposition: 2
selection OfficeIMO.Pdf.PdfPageSelection? = null optionalposition: 3
cancellationToken System.Threading.CancellationToken = default optionalposition: 4
public static IReadOnlyList<OfficeImageExportResult> ExportImages(PdfReadDocument document, OfficeImageExportFormat format, PdfImageExportOptions? options = null, PdfPageSelection? selection = null, CancellationToken cancellationToken = default) #
PdfImageExportBuilder.cs:253
Returns: IReadOnlyList<OfficeImageExportResult>

Exports selected loaded PDF pages using the shared five-format result contract.

Parameters

document OfficeIMO.Pdf.PdfReadDocument requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
options OfficeIMO.Pdf.PdfImageExportOptions? = null optionalposition: 2
selection OfficeIMO.Pdf.PdfPageSelection? = null optionalposition: 3
cancellationToken System.Threading.CancellationToken = default optionalposition: 4
public static IReadOnlyList<OfficeImageExportResult> ExportImages(PdfDocumentConversionResult conversion, OfficeImageExportFormat format, PdfImageExportOptions? options = null, PdfPageSelection? selection = null, CancellationToken cancellationToken = default) #
PdfImageExportBuilder.cs:271
Returns: IReadOnlyList<OfficeImageExportResult>

Exports pages from a source-to-PDF conversion while preserving its conversion diagnostics. This is the shared paged-image bridge for Markdown, AsciiDoc, LaTeX, RTF, OneNote, and other PDF adapters.

Parameters

conversion OfficeIMO.Pdf.PdfDocumentConversionResult requiredposition: 0
format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
options OfficeIMO.Pdf.PdfImageExportOptions? = null optionalposition: 2
selection OfficeIMO.Pdf.PdfPageSelection? = null optionalposition: 3
cancellationToken System.Threading.CancellationToken = default optionalposition: 4
ToImage 2 overloads
public static PdfPageImageExportBuilder ToImage(PdfReadPage page) #
PdfImageExportBuilder.cs:292
Returns: PdfPageImageExportBuilder

Starts fluent image export for one loaded PDF page.

Parameters

page OfficeIMO.Pdf.PdfReadPage requiredposition: 0
public static PdfPageImageExportBuilder ToImage(PdfReadPage page, PdfImageExportOptions options) #
PdfImageExportBuilder.cs:296
Returns: PdfPageImageExportBuilder

Starts fluent image export for one loaded PDF page using a cloned options snapshot.

Parameters

page OfficeIMO.Pdf.PdfReadPage requiredposition: 0
options OfficeIMO.Pdf.PdfImageExportOptions requiredposition: 1
ToImages 6 overloads
public static PdfDocumentImageExportBuilder ToImages(PdfReadDocument document) #
PdfImageExportBuilder.cs:300
Returns: PdfDocumentImageExportBuilder

Starts fluent image export for all pages in a loaded PDF document.

Parameters

document OfficeIMO.Pdf.PdfReadDocument requiredposition: 0
public static PdfDocumentImageExportBuilder ToImages(PdfReadDocument document, PdfImageExportOptions options) #
PdfImageExportBuilder.cs:304
Returns: PdfDocumentImageExportBuilder

Starts fluent image export using a cloned options snapshot.

Parameters

document OfficeIMO.Pdf.PdfReadDocument requiredposition: 0
options OfficeIMO.Pdf.PdfImageExportOptions requiredposition: 1
public static PdfDocumentImageExportBuilder ToImages(PdfDocument document) #
PdfImageExportBuilder.cs:311
Returns: PdfDocumentImageExportBuilder

Starts fluent image export for all pages in an authored or opened PDF document. The read snapshot is captured on first export so a pre-canceled operation does not materialize the document.

Parameters

document OfficeIMO.Pdf.PdfDocument requiredposition: 0
public static PdfDocumentImageExportBuilder ToImages(PdfDocument document, PdfImageExportOptions options) #
PdfImageExportBuilder.cs:318
Returns: PdfDocumentImageExportBuilder

Starts fluent image export for an authored or opened PDF document using a cloned options snapshot. The read snapshot is captured on first export.

Parameters

document OfficeIMO.Pdf.PdfDocument requiredposition: 0
options OfficeIMO.Pdf.PdfImageExportOptions requiredposition: 1
public static PdfDocumentImageExportBuilder ToImages(PdfDocumentConversionResult conversion) #
PdfImageExportBuilder.cs:324
Returns: PdfDocumentImageExportBuilder

Starts fluent paged-image export from a source-to-PDF conversion and carries its diagnostics into every page result.

Parameters

conversion OfficeIMO.Pdf.PdfDocumentConversionResult requiredposition: 0
public static PdfDocumentImageExportBuilder ToImages(PdfDocumentConversionResult conversion, PdfImageExportOptions options) #
PdfImageExportBuilder.cs:330
Returns: PdfDocumentImageExportBuilder

Starts fluent paged-image export with a cloned options snapshot and retained conversion diagnostics.

Parameters

conversion OfficeIMO.Pdf.PdfDocumentConversionResult requiredposition: 0
options OfficeIMO.Pdf.PdfImageExportOptions requiredposition: 1