# OneNoteVisualPdfExtensions

Visual-preserving PDF entry points backed by the native OneNote Drawing canvas.

Class 

`OfficeIMO.OneNote.Pdf`

**Namespace**

`OfficeIMO.OneNote.Pdf`

**Assembly**

`OfficeIMO.OneNote.Pdf`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[OneNoteVisualPdfExtensions.Conversion.cs:16](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Pdf/OneNoteVisualPdfExtensions.Conversion.cs#L16)

**Modifiers**

static

Visual-preserving PDF entry points backed by the native OneNote Drawing canvas.

## Inheritance

- object
- OneNoteVisualPdfExtensions

Filter members 

Show inherited

## Methods

SaveAsVisualPdf 4 overloads

`public static OfficeConversionReport SaveAsVisualPdf(OneNoteSection section, string path, OneNoteVisualPdfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasvisualpdf-officeimo-onenote-onenotesection-string-officeimo-onenote-pdf-onenotevisualpdfexportoptions-threading-cancellationtoken)

[OneNoteVisualPdfExtensions.Conversion.cs:45](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Pdf/OneNoteVisualPdfExtensions.Conversion.cs#L45)

Writes the OneNote section as page images as a PDF file and returns the complete conversion report.

Parameters

**section OfficeIMO.OneNote.OneNoteSection required**

**path string required**

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

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

Returns

`OfficeConversionReport`

`public static OfficeConversionReport SaveAsVisualPdf(OneNoteSection section, Stream stream, OneNoteVisualPdfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasvisualpdf-officeimo-onenote-onenotesection-io-stream-officeimo-onenote-pdf-onenotevisualpdfexportoptions-threading-cancellationtoken)

[OneNoteVisualPdfExtensions.Conversion.cs:59](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Pdf/OneNoteVisualPdfExtensions.Conversion.cs#L59)

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

Parameters

**section OfficeIMO.OneNote.OneNoteSection required**

**stream System.IO.Stream required**

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

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

Returns

`OfficeConversionReport`

`public static OfficeConversionReport SaveAsVisualPdf(OneNoteNotebook notebook, string path, OneNoteVisualPdfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasvisualpdf-officeimo-onenote-onenotenotebook-string-officeimo-onenote-pdf-onenotevisualpdfexportoptions-threading-cancellationtoken)

[OneNoteVisualPdfExtensions.Conversion.cs:140](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Pdf/OneNoteVisualPdfExtensions.Conversion.cs#L140)

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

Parameters

**notebook OfficeIMO.OneNote.OneNoteNotebook required**

**path string required**

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

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

Returns

`OfficeConversionReport`

`public static OfficeConversionReport SaveAsVisualPdf(OneNoteNotebook notebook, Stream stream, OneNoteVisualPdfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasvisualpdf-officeimo-onenote-onenotenotebook-io-stream-officeimo-onenote-pdf-onenotevisualpdfexportoptions-threading-cancellationtoken)

[OneNoteVisualPdfExtensions.Conversion.cs:154](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Pdf/OneNoteVisualPdfExtensions.Conversion.cs#L154)

Writes the OneNote notebook as page images 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.OneNoteVisualPdfExportOptions? = null optional**

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

Returns

`OfficeConversionReport`

SaveAsVisualPdfAsync 4 overloads

`public static async Task<OfficeConversionReport> SaveAsVisualPdfAsync(OneNoteSection section, string path, OneNoteVisualPdfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasvisualpdfasync-officeimo-onenote-onenotesection-string-officeimo-onenote-pdf-onenotevisualpdfexportoptions-threading-cancellationtoken)

Asynchronously writes the OneNote section as page images as a PDF file and returns the complete conversion report.

Parameters

**section OfficeIMO.OneNote.OneNoteSection required**

**path string required**

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

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

Returns

`Task<OfficeConversionReport>`

`public static async Task<OfficeConversionReport> SaveAsVisualPdfAsync(OneNoteSection section, Stream stream, OneNoteVisualPdfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasvisualpdfasync-officeimo-onenote-onenotesection-io-stream-officeimo-onenote-pdf-onenotevisualpdfexportoptions-threading-cancellationtoken)

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

Parameters

**section OfficeIMO.OneNote.OneNoteSection required**

**stream System.IO.Stream required**

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

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

Returns

`Task<OfficeConversionReport>`

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

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

Parameters

**notebook OfficeIMO.OneNote.OneNoteNotebook required**

**path string required**

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

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

Returns

`Task<OfficeConversionReport>`

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

Asynchronously writes the OneNote notebook as page images 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.OneNoteVisualPdfExportOptions? = null optional**

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

Returns

`Task<OfficeConversionReport>`

ToVisualPdf 4 overloads

`public static PdfDocument ToVisualPdf(OneNoteSection section, OneNoteVisualPdfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-tovisualpdf-officeimo-onenote-onenotesection-officeimo-onenote-pdf-onenotevisualpdfexportoptions-threading-cancellationtoken)

[OneNoteVisualPdfExtensions.Conversion.cs:16](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Pdf/OneNoteVisualPdfExtensions.Conversion.cs#L16)

Converts the OneNote section as page images to a PDF model.

Parameters

**section OfficeIMO.OneNote.OneNoteSection required**

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

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

Returns

`PdfDocument`

`public static PdfDocument ToVisualPdf(OneNoteSection section, OneNoteVisualPdfExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default)` [#](#method-tovisualpdf-officeimo-onenote-onenotesection-officeimo-onenote-pdf-onenotevisualpdfexportoptions-officeimo-officeconversionreport-threading-cancellationtoken)

[OneNoteVisualPdfExtensions.Conversion.cs:21](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Pdf/OneNoteVisualPdfExtensions.Conversion.cs#L21)

Converts the OneNote section as page images and returns its completed conversion findings.

Parameters

**section OfficeIMO.OneNote.OneNoteSection required**

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

**report OfficeIMO.OfficeConversionReport required**

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

Returns

`PdfDocument`

`public static PdfDocument ToVisualPdf(OneNoteNotebook notebook, OneNoteVisualPdfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-tovisualpdf-officeimo-onenote-onenotenotebook-officeimo-onenote-pdf-onenotevisualpdfexportoptions-threading-cancellationtoken)

[OneNoteVisualPdfExtensions.Conversion.cs:111](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Pdf/OneNoteVisualPdfExtensions.Conversion.cs#L111)

Converts the OneNote notebook as page images to a PDF model.

Parameters

**notebook OfficeIMO.OneNote.OneNoteNotebook required**

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

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

Returns

`PdfDocument`

`public static PdfDocument ToVisualPdf(OneNoteNotebook notebook, OneNoteVisualPdfExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default)` [#](#method-tovisualpdf-officeimo-onenote-onenotenotebook-officeimo-onenote-pdf-onenotevisualpdfexportoptions-officeimo-officeconversionreport-threading-cancellationtoken)

[OneNoteVisualPdfExtensions.Conversion.cs:116](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Pdf/OneNoteVisualPdfExtensions.Conversion.cs#L116)

Converts the OneNote notebook as page images and returns its completed conversion findings.

Parameters

**notebook OfficeIMO.OneNote.OneNoteNotebook required**

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

**report OfficeIMO.OfficeConversionReport required**

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

Returns

`PdfDocument`

ToVisualPdfAsync 2 overloads

`public static async Task<OfficeConversionResult<PdfDocument>> ToVisualPdfAsync(OneNoteSection section, OneNoteVisualPdfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-tovisualpdfasync-officeimo-onenote-onenotesection-officeimo-onenote-pdf-onenotevisualpdfexportoptions-threading-cancellationtoken)

Converts the OneNote section as page images, returning the model and report together.

Parameters

**section OfficeIMO.OneNote.OneNoteSection required**

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

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

Returns

`Task<OfficeConversionResult<PdfDocument>>`

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

Converts the OneNote notebook as page images, returning the model and report together.

Parameters

**notebook OfficeIMO.OneNote.OneNoteNotebook required**

**options OfficeIMO.OneNote.Pdf.OneNoteVisualPdfExportOptions? = 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:35153C299A915046A2C2657FE01F63BF315C08385246778527B9534E6C42A349 -->
