Get Started

API Reference

Class

PdfImageExportExtensions

Edit on GitHub
Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source OfficeIMO.Pdf/Rendering/PdfImageExportBuilder.cs:195
Modifiers static

Canonical PDF page image-export entry points.

Inheritance

  • Object
  • PdfImageExportExtensions

Methods

public static OfficeImageExportResult ExportImage(PdfReadPage page, OfficeImageExportFormat format, PdfImageExportOptions options = null) #
OfficeIMO.Pdf/Rendering/PdfImageExportBuilder.cs:212
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
ExportImages 3 overloads
public static IReadOnlyList<OfficeImageExportResult> ExportImages(PdfDocument document, OfficeImageExportFormat format, PdfImageExportOptions options = null, PdfPageSelection selection = null, CancellationToken cancellationToken = null) #
OfficeIMO.Pdf/Rendering/PdfImageExportBuilder.cs:195
Returns: IReadOnlyList<OfficeImageExportResult>

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

Parameters

arg1 OfficeIMO.Pdf.PdfDocument requiredposition: 0
arg2 OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
arg3 OfficeIMO.Pdf.PdfImageExportOptions = null optionalposition: 2
arg4 OfficeIMO.Pdf.PdfPageSelection = null optionalposition: 3
arg5 System.Threading.CancellationToken = null optionalposition: 4
public static IReadOnlyList<OfficeImageExportResult> ExportImages(PdfReadDocument document, OfficeImageExportFormat format, PdfImageExportOptions options = null, PdfPageSelection selection = null, CancellationToken cancellationToken = null) #
OfficeIMO.Pdf/Rendering/PdfImageExportBuilder.cs:221
Returns: IReadOnlyList<OfficeImageExportResult>

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

Parameters

arg1 OfficeIMO.Pdf.PdfReadDocument requiredposition: 0
arg2 OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
arg3 OfficeIMO.Pdf.PdfImageExportOptions = null optionalposition: 2
arg4 OfficeIMO.Pdf.PdfPageSelection = null optionalposition: 3
arg5 System.Threading.CancellationToken = null optionalposition: 4
public static IReadOnlyList<OfficeImageExportResult> ExportImages(PdfDocumentConversionResult conversion, OfficeImageExportFormat format, PdfImageExportOptions options = null, PdfPageSelection selection = null, CancellationToken cancellationToken = null) #
OfficeIMO.Pdf/Rendering/PdfImageExportBuilder.cs:239
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

arg1 OfficeIMO.Pdf.PdfDocumentConversionResult requiredposition: 0
arg2 OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 1
arg3 OfficeIMO.Pdf.PdfImageExportOptions = null optionalposition: 2
arg4 OfficeIMO.Pdf.PdfPageSelection = null optionalposition: 3
arg5 System.Threading.CancellationToken = null optionalposition: 4
ToImage 2 overloads
public static PdfPageImageExportBuilder ToImage(PdfReadPage page) #
OfficeIMO.Pdf/Rendering/PdfImageExportBuilder.cs:252
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) #
OfficeIMO.Pdf/Rendering/PdfImageExportBuilder.cs:256
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) #
OfficeIMO.Pdf/Rendering/PdfImageExportBuilder.cs:260
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) #
OfficeIMO.Pdf/Rendering/PdfImageExportBuilder.cs:264
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) #
OfficeIMO.Pdf/Rendering/PdfImageExportBuilder.cs:271
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) #
OfficeIMO.Pdf/Rendering/PdfImageExportBuilder.cs:278
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) #
OfficeIMO.Pdf/Rendering/PdfImageExportBuilder.cs:284
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) #
OfficeIMO.Pdf/Rendering/PdfImageExportBuilder.cs:290
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