# OneNoteVisualHtmlExtensions

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

Class 

`OfficeIMO.OneNote.Html`

**Namespace**

`OfficeIMO.OneNote.Html`

**Assembly**

`OfficeIMO.OneNote.Html`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[OneNoteVisualHtmlExtensions.Conversion.cs:8](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Html/OneNoteVisualHtmlExtensions.Conversion.cs#L8)

**Modifiers**

static

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

## Inheritance

- object
- OneNoteVisualHtmlExtensions

Filter members 

Show inherited

## Methods

SaveAsVisualHtml 4 overloads

`public static OfficeConversionReport SaveAsVisualHtml(OneNoteSection section, string path, OneNoteVisualHtmlExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasvisualhtml-officeimo-onenote-onenotesection-string-officeimo-onenote-html-onenotevisualhtmlexportoptions-threading-cancellationtoken)

[OneNoteVisualHtmlExtensions.Conversion.cs:30](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Html/OneNoteVisualHtmlExtensions.Conversion.cs#L30)

Writes the converted output to a path and returns the conversion report.

Parameters

**section OfficeIMO.OneNote.OneNoteSection required**

**path string required**

**options OfficeIMO.OneNote.Html.OneNoteVisualHtmlExportOptions? = null optional**

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

Returns

`OfficeConversionReport`

`public static OfficeConversionReport SaveAsVisualHtml(OneNoteSection section, Stream stream, OneNoteVisualHtmlExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasvisualhtml-officeimo-onenote-onenotesection-io-stream-officeimo-onenote-html-onenotevisualhtmlexportoptions-threading-cancellationtoken)

[OneNoteVisualHtmlExtensions.Conversion.cs:37](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Html/OneNoteVisualHtmlExtensions.Conversion.cs#L37)

Writes the converted output to a caller-owned stream, which stays open and returns the conversion report.

Parameters

**section OfficeIMO.OneNote.OneNoteSection required**

**stream System.IO.Stream required**

**options OfficeIMO.OneNote.Html.OneNoteVisualHtmlExportOptions? = null optional**

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

Returns

`OfficeConversionReport`

`public static OfficeConversionReport SaveAsVisualHtml(OneNoteNotebook notebook, string path, OneNoteVisualHtmlExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasvisualhtml-officeimo-onenote-onenotenotebook-string-officeimo-onenote-html-onenotevisualhtmlexportoptions-threading-cancellationtoken)

[OneNoteVisualHtmlExtensions.Conversion.cs:89](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Html/OneNoteVisualHtmlExtensions.Conversion.cs#L89)

Writes the converted output to a path and returns the conversion report.

Parameters

**notebook OfficeIMO.OneNote.OneNoteNotebook required**

**path string required**

**options OfficeIMO.OneNote.Html.OneNoteVisualHtmlExportOptions? = null optional**

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

Returns

`OfficeConversionReport`

`public static OfficeConversionReport SaveAsVisualHtml(OneNoteNotebook notebook, Stream stream, OneNoteVisualHtmlExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasvisualhtml-officeimo-onenote-onenotenotebook-io-stream-officeimo-onenote-html-onenotevisualhtmlexportoptions-threading-cancellationtoken)

[OneNoteVisualHtmlExtensions.Conversion.cs:96](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Html/OneNoteVisualHtmlExtensions.Conversion.cs#L96)

Writes the converted output to a caller-owned stream, which stays open and returns the conversion report.

Parameters

**notebook OfficeIMO.OneNote.OneNoteNotebook required**

**stream System.IO.Stream required**

**options OfficeIMO.OneNote.Html.OneNoteVisualHtmlExportOptions? = null optional**

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

Returns

`OfficeConversionReport`

SaveAsVisualHtmlAsync 4 overloads

`public static async Task<OfficeConversionReport> SaveAsVisualHtmlAsync(OneNoteSection section, string path, OneNoteVisualHtmlExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasvisualhtmlasync-officeimo-onenote-onenotesection-string-officeimo-onenote-html-onenotevisualhtmlexportoptions-threading-cancellationtoken)

Asynchronously writes the converted output to a path and returns the conversion report.

Parameters

**section OfficeIMO.OneNote.OneNoteSection required**

**path string required**

**options OfficeIMO.OneNote.Html.OneNoteVisualHtmlExportOptions? = null optional**

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

Returns

`Task<OfficeConversionReport>`

`public static async Task<OfficeConversionReport> SaveAsVisualHtmlAsync(OneNoteSection section, Stream stream, OneNoteVisualHtmlExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasvisualhtmlasync-officeimo-onenote-onenotesection-io-stream-officeimo-onenote-html-onenotevisualhtmlexportoptions-threading-cancellationtoken)

Asynchronously writes the converted output to a caller-owned stream and returns the conversion report.

Parameters

**section OfficeIMO.OneNote.OneNoteSection required**

**stream System.IO.Stream required**

**options OfficeIMO.OneNote.Html.OneNoteVisualHtmlExportOptions? = null optional**

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

Returns

`Task<OfficeConversionReport>`

`public static async Task<OfficeConversionReport> SaveAsVisualHtmlAsync(OneNoteNotebook notebook, string path, OneNoteVisualHtmlExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasvisualhtmlasync-officeimo-onenote-onenotenotebook-string-officeimo-onenote-html-onenotevisualhtmlexportoptions-threading-cancellationtoken)

Asynchronously writes the converted output to a path and returns the conversion report.

Parameters

**notebook OfficeIMO.OneNote.OneNoteNotebook required**

**path string required**

**options OfficeIMO.OneNote.Html.OneNoteVisualHtmlExportOptions? = null optional**

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

Returns

`Task<OfficeConversionReport>`

`public static async Task<OfficeConversionReport> SaveAsVisualHtmlAsync(OneNoteNotebook notebook, Stream stream, OneNoteVisualHtmlExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasvisualhtmlasync-officeimo-onenote-onenotenotebook-io-stream-officeimo-onenote-html-onenotevisualhtmlexportoptions-threading-cancellationtoken)

Asynchronously writes the converted output to a caller-owned stream and returns the conversion report.

Parameters

**notebook OfficeIMO.OneNote.OneNoteNotebook required**

**stream System.IO.Stream required**

**options OfficeIMO.OneNote.Html.OneNoteVisualHtmlExportOptions? = null optional**

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

Returns

`Task<OfficeConversionReport>`

ToVisualHtml 4 overloads

`public static string ToVisualHtml(OneNoteSection section, OneNoteVisualHtmlExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-tovisualhtml-officeimo-onenote-onenotesection-officeimo-onenote-html-onenotevisualhtmlexportoptions-threading-cancellationtoken)

[OneNoteVisualHtmlExtensions.Conversion.cs:8](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Html/OneNoteVisualHtmlExtensions.Conversion.cs#L8)

Converts a section to visual HTML with one SVG canvas per page.

Parameters

**section OfficeIMO.OneNote.OneNoteSection required**

**options OfficeIMO.OneNote.Html.OneNoteVisualHtmlExportOptions? = null optional**

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

Returns

`string`

`public static string ToVisualHtml(OneNoteSection section, OneNoteVisualHtmlExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default)` [#](#method-tovisualhtml-officeimo-onenote-onenotesection-officeimo-onenote-html-onenotevisualhtmlexportoptions-officeimo-officeconversionreport-threading-cancellationtoken)

[OneNoteVisualHtmlExtensions.Conversion.cs:13](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Html/OneNoteVisualHtmlExtensions.Conversion.cs#L13)

Converts a section to visual HTML with one SVG canvas per page and returns the completed conversion report.

Parameters

**section OfficeIMO.OneNote.OneNoteSection required**

**options OfficeIMO.OneNote.Html.OneNoteVisualHtmlExportOptions? required**

**report OfficeIMO.OfficeConversionReport required**

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

Returns

`string`

`public static string ToVisualHtml(OneNoteNotebook notebook, OneNoteVisualHtmlExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-tovisualhtml-officeimo-onenote-onenotenotebook-officeimo-onenote-html-onenotevisualhtmlexportoptions-threading-cancellationtoken)

[OneNoteVisualHtmlExtensions.Conversion.cs:67](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Html/OneNoteVisualHtmlExtensions.Conversion.cs#L67)

Converts a notebook to visual HTML with one SVG canvas per page.

Parameters

**notebook OfficeIMO.OneNote.OneNoteNotebook required**

**options OfficeIMO.OneNote.Html.OneNoteVisualHtmlExportOptions? = null optional**

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

Returns

`string`

`public static string ToVisualHtml(OneNoteNotebook notebook, OneNoteVisualHtmlExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default)` [#](#method-tovisualhtml-officeimo-onenote-onenotenotebook-officeimo-onenote-html-onenotevisualhtmlexportoptions-officeimo-officeconversionreport-threading-cancellationtoken)

[OneNoteVisualHtmlExtensions.Conversion.cs:72](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Html/OneNoteVisualHtmlExtensions.Conversion.cs#L72)

Converts a notebook to visual HTML with one SVG canvas per page and returns the completed conversion report.

Parameters

**notebook OfficeIMO.OneNote.OneNoteNotebook required**

**options OfficeIMO.OneNote.Html.OneNoteVisualHtmlExportOptions? required**

**report OfficeIMO.OfficeConversionReport required**

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

Returns

`string`

ToVisualHtmlAsync 2 overloads

`public static Task<OfficeConversionResult<string>> ToVisualHtmlAsync(OneNoteSection section, OneNoteVisualHtmlExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-tovisualhtmlasync-officeimo-onenote-onenotesection-officeimo-onenote-html-onenotevisualhtmlexportoptions-threading-cancellationtoken)

[OneNoteVisualHtmlExtensions.Conversion.cs:23](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Html/OneNoteVisualHtmlExtensions.Conversion.cs#L23)

Converts a section to visual HTML with one SVG canvas per page, returning the value and report together.

Parameters

**section OfficeIMO.OneNote.OneNoteSection required**

**options OfficeIMO.OneNote.Html.OneNoteVisualHtmlExportOptions? = null optional**

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

Returns

`Task<OfficeConversionResult<string>>`

`public static Task<OfficeConversionResult<string>> ToVisualHtmlAsync(OneNoteNotebook notebook, OneNoteVisualHtmlExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-tovisualhtmlasync-officeimo-onenote-onenotenotebook-officeimo-onenote-html-onenotevisualhtmlexportoptions-threading-cancellationtoken)

[OneNoteVisualHtmlExtensions.Conversion.cs:82](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Html/OneNoteVisualHtmlExtensions.Conversion.cs#L82)

Converts a notebook to visual HTML with one SVG canvas per page, returning the value and report together.

Parameters

**notebook OfficeIMO.OneNote.OneNoteNotebook required**

**options OfficeIMO.OneNote.Html.OneNoteVisualHtmlExportOptions? = null optional**

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

Returns

`Task<OfficeConversionResult<string>>`

## 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:06DE17B4C0939A440260AC12A6CA8E29E3EA7DF90CFE0550A07EF857304D228D -->
