Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

ExcelPdfConverterExtensions

OfficeIMO.Excel.Pdf

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

First-party Excel workbook to PDF conversion helpers.

Inheritance

  • object
  • ExcelPdfConverterExtensions

Methods

SaveAsPdf 2 overloads
public static OfficeConversionReport SaveAsPdf(ExcelDocument document, string path, ExcelPdfExportOptions? options = null, CancellationToken cancellationToken = default) #

Writes a PDF file and returns the complete conversion report.

Parameters

document OfficeIMO.Excel.ExcelDocument required
path string required
options OfficeIMO.Excel.Pdf.ExcelPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

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

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

Parameters

document OfficeIMO.Excel.ExcelDocument required
stream System.IO.Stream required
options OfficeIMO.Excel.Pdf.ExcelPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

OfficeConversionReport
SaveAsPdfAsync 2 overloads
public static async Task<OfficeConversionReport> SaveAsPdfAsync(ExcelDocument document, string path, ExcelPdfExportOptions? options = null, CancellationToken cancellationToken = default) #

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

Parameters

document OfficeIMO.Excel.ExcelDocument required
path string required
options OfficeIMO.Excel.Pdf.ExcelPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
public static async Task<OfficeConversionReport> SaveAsPdfAsync(ExcelDocument document, Stream stream, ExcelPdfExportOptions? options = null, CancellationToken cancellationToken = default) #

Asynchronously writes PDF to a caller-owned stream and returns its conversion report.

Parameters

document OfficeIMO.Excel.ExcelDocument required
stream System.IO.Stream required
options OfficeIMO.Excel.Pdf.ExcelPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionReport>
ToPdf 2 overloads
public static PdfDocument ToPdf(ExcelDocument document, ExcelPdfExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts the source document to a PDF model.

Parameters

document OfficeIMO.Excel.ExcelDocument required
options OfficeIMO.Excel.Pdf.ExcelPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

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

Converts the source document and returns its completed conversion findings.

Parameters

document OfficeIMO.Excel.ExcelDocument required
options OfficeIMO.Excel.Pdf.ExcelPdfExportOptions? required
report OfficeIMO.OfficeConversionReport required
cancellationToken System.Threading.CancellationToken = default optional

Returns

PdfDocument
public static async Task<OfficeConversionResult<PdfDocument>> ToPdfAsync(ExcelDocument document, ExcelPdfExportOptions? options = null, CancellationToken cancellationToken = default) #

Converts the source document, returning the model and report together.

Parameters

document OfficeIMO.Excel.ExcelDocument required
options OfficeIMO.Excel.Pdf.ExcelPdfExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<OfficeConversionResult<PdfDocument>>