# OneNoteHtmlConverterExtensions

Converts typed offline OneNote models to HTML through the shared Markdown model.

Class 

`OfficeIMO.OneNote.Html`

**Namespace**

`OfficeIMO.OneNote.Html`

**Assembly**

`OfficeIMO.OneNote.Html`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[OneNoteHtmlConverterExtensions.Conversion.cs:9](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Html/OneNoteHtmlConverterExtensions.Conversion.cs#L9)

**Modifiers**

static

Converts typed offline OneNote models to HTML through the shared Markdown model.

## Inheritance

- object
- OneNoteHtmlConverterExtensions

Filter members 

Show inherited

## Methods

SaveAsHtml 4 overloads

`public static OfficeConversionReport SaveAsHtml(OneNoteSection section, string path, OneNoteHtmlExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveashtml-officeimo-onenote-onenotesection-string-officeimo-onenote-html-onenotehtmlexportoptions-threading-cancellationtoken)

[OneNoteHtmlConverterExtensions.Conversion.cs:33](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Html/OneNoteHtmlConverterExtensions.Conversion.cs#L33)

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.OneNoteHtmlExportOptions? = null optional**

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

Returns

`OfficeConversionReport`

`public static OfficeConversionReport SaveAsHtml(OneNoteSection section, Stream stream, OneNoteHtmlExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveashtml-officeimo-onenote-onenotesection-io-stream-officeimo-onenote-html-onenotehtmlexportoptions-threading-cancellationtoken)

[OneNoteHtmlConverterExtensions.Conversion.cs:40](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Html/OneNoteHtmlConverterExtensions.Conversion.cs#L40)

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.OneNoteHtmlExportOptions? = null optional**

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

Returns

`OfficeConversionReport`

`public static OfficeConversionReport SaveAsHtml(OneNoteNotebook notebook, string path, OneNoteHtmlExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveashtml-officeimo-onenote-onenotenotebook-string-officeimo-onenote-html-onenotehtmlexportoptions-threading-cancellationtoken)

[OneNoteHtmlConverterExtensions.Conversion.cs:94](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Html/OneNoteHtmlConverterExtensions.Conversion.cs#L94)

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.OneNoteHtmlExportOptions? = null optional**

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

Returns

`OfficeConversionReport`

`public static OfficeConversionReport SaveAsHtml(OneNoteNotebook notebook, Stream stream, OneNoteHtmlExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveashtml-officeimo-onenote-onenotenotebook-io-stream-officeimo-onenote-html-onenotehtmlexportoptions-threading-cancellationtoken)

[OneNoteHtmlConverterExtensions.Conversion.cs:101](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Html/OneNoteHtmlConverterExtensions.Conversion.cs#L101)

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.OneNoteHtmlExportOptions? = null optional**

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

Returns

`OfficeConversionReport`

SaveAsHtmlAsync 4 overloads

`public static async Task<OfficeConversionReport> SaveAsHtmlAsync(OneNoteSection section, string path, OneNoteHtmlExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveashtmlasync-officeimo-onenote-onenotesection-string-officeimo-onenote-html-onenotehtmlexportoptions-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.OneNoteHtmlExportOptions? = null optional**

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

Returns

`Task<OfficeConversionReport>`

`public static async Task<OfficeConversionReport> SaveAsHtmlAsync(OneNoteSection section, Stream stream, OneNoteHtmlExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveashtmlasync-officeimo-onenote-onenotesection-io-stream-officeimo-onenote-html-onenotehtmlexportoptions-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.OneNoteHtmlExportOptions? = null optional**

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

Returns

`Task<OfficeConversionReport>`

`public static async Task<OfficeConversionReport> SaveAsHtmlAsync(OneNoteNotebook notebook, string path, OneNoteHtmlExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveashtmlasync-officeimo-onenote-onenotenotebook-string-officeimo-onenote-html-onenotehtmlexportoptions-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.OneNoteHtmlExportOptions? = null optional**

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

Returns

`Task<OfficeConversionReport>`

`public static async Task<OfficeConversionReport> SaveAsHtmlAsync(OneNoteNotebook notebook, Stream stream, OneNoteHtmlExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveashtmlasync-officeimo-onenote-onenotenotebook-io-stream-officeimo-onenote-html-onenotehtmlexportoptions-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.OneNoteHtmlExportOptions? = null optional**

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

Returns

`Task<OfficeConversionReport>`

ToHtml 4 overloads

`public static string ToHtml(OneNoteSection section, OneNoteHtmlExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-tohtml-officeimo-onenote-onenotesection-officeimo-onenote-html-onenotehtmlexportoptions-threading-cancellationtoken)

[OneNoteHtmlConverterExtensions.Conversion.cs:9](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Html/OneNoteHtmlConverterExtensions.Conversion.cs#L9)

Converts a section to semantic HTML through the shared Markdown model.

Parameters

**section OfficeIMO.OneNote.OneNoteSection required**

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

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

Returns

`string`

`public static string ToHtml(OneNoteSection section, OneNoteHtmlExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default)` [#](#method-tohtml-officeimo-onenote-onenotesection-officeimo-onenote-html-onenotehtmlexportoptions-officeimo-officeconversionreport-threading-cancellationtoken)

[OneNoteHtmlConverterExtensions.Conversion.cs:14](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Html/OneNoteHtmlConverterExtensions.Conversion.cs#L14)

Converts a section to semantic HTML through the shared Markdown model and returns the completed conversion report.

Parameters

**section OfficeIMO.OneNote.OneNoteSection required**

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

**report OfficeIMO.OfficeConversionReport required**

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

Returns

`string`

`public static string ToHtml(OneNoteNotebook notebook, OneNoteHtmlExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-tohtml-officeimo-onenote-onenotenotebook-officeimo-onenote-html-onenotehtmlexportoptions-threading-cancellationtoken)

[OneNoteHtmlConverterExtensions.Conversion.cs:70](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Html/OneNoteHtmlConverterExtensions.Conversion.cs#L70)

Converts a notebook to semantic HTML through the shared Markdown model.

Parameters

**notebook OfficeIMO.OneNote.OneNoteNotebook required**

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

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

Returns

`string`

`public static string ToHtml(OneNoteNotebook notebook, OneNoteHtmlExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default)` [#](#method-tohtml-officeimo-onenote-onenotenotebook-officeimo-onenote-html-onenotehtmlexportoptions-officeimo-officeconversionreport-threading-cancellationtoken)

[OneNoteHtmlConverterExtensions.Conversion.cs:75](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Html/OneNoteHtmlConverterExtensions.Conversion.cs#L75)

Converts a notebook to semantic HTML through the shared Markdown model and returns the completed conversion report.

Parameters

**notebook OfficeIMO.OneNote.OneNoteNotebook required**

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

**report OfficeIMO.OfficeConversionReport required**

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

Returns

`string`

ToHtmlAsync 2 overloads

`public static Task<OfficeConversionResult<string>> ToHtmlAsync(OneNoteSection section, OneNoteHtmlExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-tohtmlasync-officeimo-onenote-onenotesection-officeimo-onenote-html-onenotehtmlexportoptions-threading-cancellationtoken)

[OneNoteHtmlConverterExtensions.Conversion.cs:26](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Html/OneNoteHtmlConverterExtensions.Conversion.cs#L26)

Converts a section to semantic HTML through the shared Markdown model, returning the value and report together.

Parameters

**section OfficeIMO.OneNote.OneNoteSection required**

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

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

Returns

`Task<OfficeConversionResult<string>>`

`public static Task<OfficeConversionResult<string>> ToHtmlAsync(OneNoteNotebook notebook, OneNoteHtmlExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-tohtmlasync-officeimo-onenote-onenotenotebook-officeimo-onenote-html-onenotehtmlexportoptions-threading-cancellationtoken)

[OneNoteHtmlConverterExtensions.Conversion.cs:87](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Html/OneNoteHtmlConverterExtensions.Conversion.cs#L87)

Converts a notebook to semantic HTML through the shared Markdown model, returning the value and report together.

Parameters

**notebook OfficeIMO.OneNote.OneNoteNotebook required**

**options OfficeIMO.OneNote.Html.OneNoteHtmlExportOptions? = 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:474A9F6FB4B8DEF2652FC4C8F7F7CDDBCF6E401C47B6DAD2D7FDD642620D62D7 -->
