Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

PdfImageConverterExtensions

OfficeIMO.Pdf

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

Converts ordered image sources into PDF pages.

Inheritance

  • object
  • PdfImageConverterExtensions

Methods

SaveAsPdf 4 overloads
public static OfficeConversionReport SaveAsPdf(IEnumerable<string> imagePaths, string path, PdfImageImportOptions? options = null, CancellationToken cancellationToken = default) #

Writes ordered image pages to a file and returns completed conversion findings.

Parameters

imagePaths System.Collections.Generic.IEnumerable<string> required
path string required
options OfficeIMO.Pdf.PdfImageImportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public static OfficeConversionReport SaveAsPdf(IEnumerable<string> imagePaths, Stream stream, PdfImageImportOptions? options = null, CancellationToken cancellationToken = default) #

Writes ordered image pages to a caller-owned stream and returns completed conversion findings.

Parameters

imagePaths System.Collections.Generic.IEnumerable<string> required
stream System.IO.Stream required
options OfficeIMO.Pdf.PdfImageImportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public static OfficeConversionReport SaveAsPdf(IEnumerable<PdfImageDocumentSource> images, string path, PdfImageImportOptions? options = null, CancellationToken cancellationToken = default) #

Writes ordered image pages to a file and returns completed conversion findings.

Parameters

images System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfImageDocumentSource> required
path string required
options OfficeIMO.Pdf.PdfImageImportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
public static OfficeConversionReport SaveAsPdf(IEnumerable<PdfImageDocumentSource> images, Stream stream, PdfImageImportOptions? options = null, CancellationToken cancellationToken = default) #

Writes ordered image pages to a caller-owned stream and returns completed conversion findings.

Parameters

images System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfImageDocumentSource> required
stream System.IO.Stream required
options OfficeIMO.Pdf.PdfImageImportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
SaveAsPdfAsync 4 overloads
public static async Task<OfficeConversionReport> SaveAsPdfAsync(IEnumerable<string> imagePaths, string path, PdfImageImportOptions? options = null, CancellationToken cancellationToken = default) #

Writes ordered image pages to a file and returns completed conversion findings.

Parameters

imagePaths System.Collections.Generic.IEnumerable<string> required
path string required
options OfficeIMO.Pdf.PdfImageImportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
public static async Task<OfficeConversionReport> SaveAsPdfAsync(IEnumerable<string> imagePaths, Stream stream, PdfImageImportOptions? options = null, CancellationToken cancellationToken = default) #

Writes ordered image pages to a caller-owned stream and returns completed conversion findings.

Parameters

imagePaths System.Collections.Generic.IEnumerable<string> required
stream System.IO.Stream required
options OfficeIMO.Pdf.PdfImageImportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
public static async Task<OfficeConversionReport> SaveAsPdfAsync(IEnumerable<PdfImageDocumentSource> images, string path, PdfImageImportOptions? options = null, CancellationToken cancellationToken = default) #

Writes ordered image pages to a file and returns completed conversion findings.

Parameters

images System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfImageDocumentSource> required
path string required
options OfficeIMO.Pdf.PdfImageImportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
public static async Task<OfficeConversionReport> SaveAsPdfAsync(IEnumerable<PdfImageDocumentSource> images, Stream stream, PdfImageImportOptions? options = null, CancellationToken cancellationToken = default) #

Writes ordered image pages to a caller-owned stream and returns completed conversion findings.

Parameters

images System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfImageDocumentSource> required
stream System.IO.Stream required
options OfficeIMO.Pdf.PdfImageImportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
ToPdf 4 overloads
public static PdfDocument ToPdf(IEnumerable<string> imagePaths, PdfImageImportOptions? options = null, CancellationToken cancellationToken = default) #

Converts each image to a PDF page in caller order.

Parameters

imagePaths System.Collections.Generic.IEnumerable<string> required
options OfficeIMO.Pdf.PdfImageImportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional
public static PdfDocument ToPdf(IEnumerable<string> imagePaths, PdfImageImportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #

Converts ordered images and returns completed rendering findings.

Parameters

imagePaths System.Collections.Generic.IEnumerable<string> required
options OfficeIMO.Pdf.PdfImageImportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional
public static PdfDocument ToPdf(IEnumerable<PdfImageDocumentSource> images, PdfImageImportOptions? options = null, CancellationToken cancellationToken = default) #

Converts each image to a PDF page in caller order.

Parameters

images System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfImageDocumentSource> required
options OfficeIMO.Pdf.PdfImageImportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional
public static PdfDocument ToPdf(IEnumerable<PdfImageDocumentSource> images, PdfImageImportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default) #

Converts ordered images and returns completed rendering findings.

Parameters

images System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfImageDocumentSource> required
options OfficeIMO.Pdf.PdfImageImportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional
ToPdfAsync 2 overloads
public static async Task<OfficeConversionResult<PdfDocument>> ToPdfAsync(IEnumerable<string> imagePaths, PdfImageImportOptions? options = null, CancellationToken cancellationToken = default) #

Returns the PDF model and completed rendering report together.

Parameters

imagePaths System.Collections.Generic.IEnumerable<string> required
options OfficeIMO.Pdf.PdfImageImportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<PdfDocument>>
public static async Task<OfficeConversionResult<PdfDocument>> ToPdfAsync(IEnumerable<PdfImageDocumentSource> images, PdfImageImportOptions? options = null, CancellationToken cancellationToken = default) #

Returns the PDF model and completed rendering report together.

Parameters

images System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfImageDocumentSource> required
options OfficeIMO.Pdf.PdfImageImportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<PdfDocument>>