# ExcelPdfConverterExtensions

First-party Excel workbook to PDF conversion helpers.

Class 

`OfficeIMO.Excel.Pdf`

**Namespace**

`OfficeIMO.Excel.Pdf`

**Assembly**

`OfficeIMO.Excel.Pdf`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[ExcelPdfConverterExtensions.Conversion.cs:10](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Excel.Pdf/ExcelPdfConverterExtensions.Conversion.cs#L10)

**Modifiers**

static

First-party Excel workbook to PDF conversion helpers.

## Inheritance

- object
- ExcelPdfConverterExtensions

Filter members 

Show inherited

## Methods

SaveAsPdf 2 overloads

`public static OfficeConversionReport SaveAsPdf(ExcelDocument document, string path, ExcelPdfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveaspdf-officeimo-excel-exceldocument-string-officeimo-excel-pdf-excelpdfexportoptions-threading-cancellationtoken)

[ExcelPdfConverterExtensions.Conversion.cs:37](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Excel.Pdf/ExcelPdfConverterExtensions.Conversion.cs#L37)

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)` [#](#method-saveaspdf-officeimo-excel-exceldocument-io-stream-officeimo-excel-pdf-excelpdfexportoptions-threading-cancellationtoken)

[ExcelPdfConverterExtensions.Conversion.cs:50](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Excel.Pdf/ExcelPdfConverterExtensions.Conversion.cs#L50)

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)` [#](#method-saveaspdfasync-officeimo-excel-exceldocument-string-officeimo-excel-pdf-excelpdfexportoptions-threading-cancellationtoken)

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)` [#](#method-saveaspdfasync-officeimo-excel-exceldocument-io-stream-officeimo-excel-pdf-excelpdfexportoptions-threading-cancellationtoken)

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)` [#](#method-topdf-officeimo-excel-exceldocument-officeimo-excel-pdf-excelpdfexportoptions-threading-cancellationtoken)

[ExcelPdfConverterExtensions.Conversion.cs:10](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Excel.Pdf/ExcelPdfConverterExtensions.Conversion.cs#L10)

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)` [#](#method-topdf-officeimo-excel-exceldocument-officeimo-excel-pdf-excelpdfexportoptions-officeimo-officeconversionreport-threading-cancellationtoken)

[ExcelPdfConverterExtensions.Conversion.cs:15](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Excel.Pdf/ExcelPdfConverterExtensions.Conversion.cs#L15)

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)` [#](#method-topdfasync-officeimo-excel-exceldocument-officeimo-excel-pdf-excelpdfexportoptions-threading-cancellationtoken)

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>>`

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

<!-- PowerForge markdown artifact sha256:49608364447E6154B2EC49783DF73ABCBC39778CB0B230B672F41E8A566C269A -->
