# OneNoteNotebookPdfConverterExtensions

Converts offline OneNote notebooks to semantic PDF documents.

Class 

`OfficeIMO.OneNote.Pdf`

**Namespace**

`OfficeIMO.OneNote.Pdf`

**Assembly**

`OfficeIMO.OneNote.Pdf`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[OneNoteNotebookPdfConverterExtensions.cs:17](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Pdf/OneNoteNotebookPdfConverterExtensions.cs#L17)

**Modifiers**

static

Converts offline OneNote notebooks to semantic PDF documents.

## Inheritance

- object
- OneNoteNotebookPdfConverterExtensions

Filter members 

Show inherited

## Methods

SaveAsPdf 2 overloads

`public static OfficeConversionReport SaveAsPdf(OneNoteNotebook notebook, string path, OneNotePdfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveaspdf-officeimo-onenote-onenotenotebook-string-officeimo-onenote-pdf-onenotepdfexportoptions-threading-cancellationtoken)

[OneNoteNotebookPdfConverterExtensions.cs:46](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Pdf/OneNoteNotebookPdfConverterExtensions.cs#L46)

Writes the OneNote notebook as a PDF file and returns the complete conversion report.

Parameters

**notebook OfficeIMO.OneNote.OneNoteNotebook required**

**path string required**

**options OfficeIMO.OneNote.Pdf.OneNotePdfExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`OfficeConversionReport`

`public static OfficeConversionReport SaveAsPdf(OneNoteNotebook notebook, Stream stream, OneNotePdfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveaspdf-officeimo-onenote-onenotenotebook-io-stream-officeimo-onenote-pdf-onenotepdfexportoptions-threading-cancellationtoken)

[OneNoteNotebookPdfConverterExtensions.cs:60](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Pdf/OneNoteNotebookPdfConverterExtensions.cs#L60)

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

Parameters

**notebook OfficeIMO.OneNote.OneNoteNotebook required**

**stream System.IO.Stream required**

**options OfficeIMO.OneNote.Pdf.OneNotePdfExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`OfficeConversionReport`

SaveAsPdfAsync 2 overloads

`public static async Task<OfficeConversionReport> SaveAsPdfAsync(OneNoteNotebook notebook, string path, OneNotePdfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveaspdfasync-officeimo-onenote-onenotenotebook-string-officeimo-onenote-pdf-onenotepdfexportoptions-threading-cancellationtoken)

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

Parameters

**notebook OfficeIMO.OneNote.OneNoteNotebook required**

**path string required**

**options OfficeIMO.OneNote.Pdf.OneNotePdfExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<OfficeConversionReport>`

`public static async Task<OfficeConversionReport> SaveAsPdfAsync(OneNoteNotebook notebook, Stream stream, OneNotePdfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveaspdfasync-officeimo-onenote-onenotenotebook-io-stream-officeimo-onenote-pdf-onenotepdfexportoptions-threading-cancellationtoken)

Asynchronously writes the OneNote notebook as PDF to a caller-owned stream and returns the complete conversion report.

Parameters

**notebook OfficeIMO.OneNote.OneNoteNotebook required**

**stream System.IO.Stream required**

**options OfficeIMO.OneNote.Pdf.OneNotePdfExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`Task<OfficeConversionReport>`

ToPdf 2 overloads

`public static PdfDocument ToPdf(OneNoteNotebook notebook, OneNotePdfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-topdf-officeimo-onenote-onenotenotebook-officeimo-onenote-pdf-onenotepdfexportoptions-threading-cancellationtoken)

[OneNoteNotebookPdfConverterExtensions.cs:17](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Pdf/OneNoteNotebookPdfConverterExtensions.cs#L17)

Converts the OneNote notebook to a PDF model.

Parameters

**notebook OfficeIMO.OneNote.OneNoteNotebook required**

**options OfficeIMO.OneNote.Pdf.OneNotePdfExportOptions? = null optional**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`PdfDocument`

`public static PdfDocument ToPdf(OneNoteNotebook notebook, OneNotePdfExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default)` [#](#method-topdf-officeimo-onenote-onenotenotebook-officeimo-onenote-pdf-onenotepdfexportoptions-officeimo-officeconversionreport-threading-cancellationtoken)

[OneNoteNotebookPdfConverterExtensions.cs:22](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Pdf/OneNoteNotebookPdfConverterExtensions.cs#L22)

Converts the OneNote notebook and returns its completed conversion findings.

Parameters

**notebook OfficeIMO.OneNote.OneNoteNotebook required**

**options OfficeIMO.OneNote.Pdf.OneNotePdfExportOptions? required**

**report OfficeIMO.OfficeConversionReport required**

**cancellationToken System.Threading.CancellationToken = default optional**

Returns

`PdfDocument`

`public static async Task<OfficeConversionResult<PdfDocument>> ToPdfAsync(OneNoteNotebook notebook, OneNotePdfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-topdfasync-officeimo-onenote-onenotenotebook-officeimo-onenote-pdf-onenotepdfexportoptions-threading-cancellationtoken)

Converts the OneNote notebook, returning the model and report together.

Parameters

**notebook OfficeIMO.OneNote.OneNoteNotebook required**

**options OfficeIMO.OneNote.Pdf.OneNotePdfExportOptions? = 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:2BA2A835094623B82460930B0A8BCB8823DD23D4680CCDEB65E82026CF9C996A -->
