API Reference
Class
ExcelPdfConverterExtensions
First-party Excel workbook to PDF conversion helpers.
Inheritance
- Object
- ExcelPdfConverterExtensions
Methods
SaveAsPdf 2 overloads
public static PdfSaveResult SaveAsPdf(ExcelDocument document, String path, ExcelToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
PdfSaveResultSaves an Excel workbook as a PDF file.
Parameters
- arg1 OfficeIMO.Excel.ExcelDocument
- arg2 System.String
- arg3 OfficeIMO.Excel.Pdf.ExcelToPdfOptions = null
- arg4 System.Threading.CancellationToken = default
public static PdfSaveResult SaveAsPdf(ExcelDocument document, Stream stream, ExcelToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
PdfSaveResultWrites an Excel workbook as PDF to a stream.
Parameters
- arg1 OfficeIMO.Excel.ExcelDocument
- arg2 System.IO.Stream
- arg3 OfficeIMO.Excel.Pdf.ExcelToPdfOptions = null
- arg4 System.Threading.CancellationToken = default
SaveAsPdfAsync 2 overloads
public static async Task<PdfSaveResult> SaveAsPdfAsync(ExcelDocument document, String path, ExcelToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
Task<PdfSaveResult>Converts synchronously, then asynchronously saves an Excel workbook PDF at the specified path.
Parameters
- arg1 OfficeIMO.Excel.ExcelDocument
- arg2 System.String
- arg3 OfficeIMO.Excel.Pdf.ExcelToPdfOptions = null
- arg4 System.Threading.CancellationToken = default
public static async Task<PdfSaveResult> SaveAsPdfAsync(ExcelDocument document, Stream stream, ExcelToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
Task<PdfSaveResult>Converts synchronously, then asynchronously saves an Excel workbook PDF to a caller-owned stream.
Parameters
- arg1 OfficeIMO.Excel.ExcelDocument
- arg2 System.IO.Stream
- arg3 OfficeIMO.Excel.Pdf.ExcelToPdfOptions = null
- arg4 System.Threading.CancellationToken = default
SaveAsPdfResult 2 overloads
public static PdfSaveResult SaveAsPdfResult(ExcelDocument document, String path, ExcelToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
PdfSaveResultAttempts to save an Excel workbook as a PDF file and returns output diagnostics instead of throwing.
Parameters
- arg1 OfficeIMO.Excel.ExcelDocument
- arg2 System.String
- arg3 OfficeIMO.Excel.Pdf.ExcelToPdfOptions = null
- arg4 System.Threading.CancellationToken = default
public static PdfSaveResult SaveAsPdfResult(ExcelDocument document, Stream stream, ExcelToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
PdfSaveResultAttempts to write an Excel workbook as PDF to a stream and returns output diagnostics instead of throwing.
Parameters
- arg1 OfficeIMO.Excel.ExcelDocument
- arg2 System.IO.Stream
- arg3 OfficeIMO.Excel.Pdf.ExcelToPdfOptions = null
- arg4 System.Threading.CancellationToken = default
SaveAsPdfResultAsync 2 overloads
public static async Task<PdfSaveResult> SaveAsPdfResultAsync(ExcelDocument document, String path, ExcelToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
Task<PdfSaveResult>Attempts to asynchronously save an Excel workbook as PDF at the specified path.
Parameters
- arg1 OfficeIMO.Excel.ExcelDocument
- arg2 System.String
- arg3 OfficeIMO.Excel.Pdf.ExcelToPdfOptions = null
- arg4 System.Threading.CancellationToken = default
public static async Task<PdfSaveResult> SaveAsPdfResultAsync(ExcelDocument document, Stream stream, ExcelToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
Task<PdfSaveResult>Attempts to asynchronously save an Excel workbook as PDF to a caller-owned stream.
Parameters
- arg1 OfficeIMO.Excel.ExcelDocument
- arg2 System.IO.Stream
- arg3 OfficeIMO.Excel.Pdf.ExcelToPdfOptions = null
- arg4 System.Threading.CancellationToken = default
public static Byte[] ToPdfBytes(ExcelDocument document, ExcelToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
Byte[]Converts an Excel workbook to PDF bytes.
Parameters
- document OfficeIMO.Excel.ExcelDocument
- options OfficeIMO.Excel.Pdf.ExcelToPdfOptions = null
- cancellationToken System.Threading.CancellationToken = default
Examples
byte[] pdf = workbook.ToPdfBytes();
public static PdfDocument ToPdfDocument(ExcelDocument document, ExcelToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
PdfDocumentConverts an Excel workbook to a first-party OfficeIMO PDF document model.
Parameters
- document OfficeIMO.Excel.ExcelDocument
- options OfficeIMO.Excel.Pdf.ExcelToPdfOptions = null
- cancellationToken System.Threading.CancellationToken = default
public static PdfDocumentConversionResult ToPdfDocumentResult(ExcelDocument document, ExcelToPdfOptions options = null, CancellationToken cancellationToken = default) #Returns:
PdfDocumentConversionResultConverts an Excel workbook to a PDF document and returns conversion diagnostics with it.
Parameters
- document OfficeIMO.Excel.ExcelDocument
- options OfficeIMO.Excel.Pdf.ExcelToPdfOptions = null
- cancellationToken System.Threading.CancellationToken = default
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object