# OneNoteMarkdownConverterExtensions

Converts typed offline OneNote models through the first-party Markdown model.

Class 

`OfficeIMO.OneNote.Markdown`

**Namespace**

`OfficeIMO.OneNote.Markdown`

**Assembly**

`OfficeIMO.OneNote.Markdown`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[OneNoteMarkdownConverterExtensions.Conversion.cs:10](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Markdown/OneNoteMarkdownConverterExtensions.Conversion.cs#L10)

**Modifiers**

static

Converts typed offline OneNote models through the first-party Markdown model.

## Inheritance

- object
- OneNoteMarkdownConverterExtensions

Filter members 

Show inherited

## Methods

SaveAsMarkdown 4 overloads

`public static OfficeConversionReport SaveAsMarkdown(OneNoteSection section, string path, OneNoteMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasmarkdown-officeimo-onenote-onenotesection-string-officeimo-onenote-markdown-onenotemarkdownexportoptions-threading-cancellationtoken)

[OneNoteMarkdownConverterExtensions.Conversion.cs:34](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Markdown/OneNoteMarkdownConverterExtensions.Conversion.cs#L34)

Writes the section's Markdown projection as UTF-8 to a path and returns the conversion report.

Parameters

**section OfficeIMO.OneNote.OneNoteSection required**

**path string required**

**options OfficeIMO.OneNote.Markdown.OneNoteMarkdownExportOptions? = null optional**

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

Returns

`OfficeConversionReport`

`public static OfficeConversionReport SaveAsMarkdown(OneNoteSection section, Stream stream, OneNoteMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasmarkdown-officeimo-onenote-onenotesection-io-stream-officeimo-onenote-markdown-onenotemarkdownexportoptions-threading-cancellationtoken)

[OneNoteMarkdownConverterExtensions.Conversion.cs:50](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Markdown/OneNoteMarkdownConverterExtensions.Conversion.cs#L50)

Writes the section's Markdown projection as UTF-8 to a caller-owned stream and returns the conversion report.

Parameters

**section OfficeIMO.OneNote.OneNoteSection required**

**stream System.IO.Stream required**

**options OfficeIMO.OneNote.Markdown.OneNoteMarkdownExportOptions? = null optional**

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

Returns

`OfficeConversionReport`

`public static OfficeConversionReport SaveAsMarkdown(OneNoteNotebook notebook, string path, OneNoteMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasmarkdown-officeimo-onenote-onenotenotebook-string-officeimo-onenote-markdown-onenotemarkdownexportoptions-threading-cancellationtoken)

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

Writes the notebook's Markdown projection as UTF-8 to a path and returns the conversion report.

Parameters

**notebook OfficeIMO.OneNote.OneNoteNotebook required**

**path string required**

**options OfficeIMO.OneNote.Markdown.OneNoteMarkdownExportOptions? = null optional**

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

Returns

`OfficeConversionReport`

`public static OfficeConversionReport SaveAsMarkdown(OneNoteNotebook notebook, Stream stream, OneNoteMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasmarkdown-officeimo-onenote-onenotenotebook-io-stream-officeimo-onenote-markdown-onenotemarkdownexportoptions-threading-cancellationtoken)

[OneNoteMarkdownConverterExtensions.Conversion.cs:112](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Markdown/OneNoteMarkdownConverterExtensions.Conversion.cs#L112)

Writes the notebook's Markdown projection as UTF-8 to a caller-owned stream and returns the conversion report.

Parameters

**notebook OfficeIMO.OneNote.OneNoteNotebook required**

**stream System.IO.Stream required**

**options OfficeIMO.OneNote.Markdown.OneNoteMarkdownExportOptions? = null optional**

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

Returns

`OfficeConversionReport`

SaveAsMarkdownAsync 4 overloads

`public static async Task<OfficeConversionReport> SaveAsMarkdownAsync(OneNoteSection section, string path, OneNoteMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasmarkdownasync-officeimo-onenote-onenotesection-string-officeimo-onenote-markdown-onenotemarkdownexportoptions-threading-cancellationtoken)

Asynchronously writes the section's Markdown projection as UTF-8.

Parameters

**section OfficeIMO.OneNote.OneNoteSection required**

**path string required**

**options OfficeIMO.OneNote.Markdown.OneNoteMarkdownExportOptions? = null optional**

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

Returns

`Task<OfficeConversionReport>`

`public static async Task<OfficeConversionReport> SaveAsMarkdownAsync(OneNoteSection section, Stream stream, OneNoteMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasmarkdownasync-officeimo-onenote-onenotesection-io-stream-officeimo-onenote-markdown-onenotemarkdownexportoptions-threading-cancellationtoken)

Asynchronously writes the section's Markdown projection as UTF-8.

Parameters

**section OfficeIMO.OneNote.OneNoteSection required**

**stream System.IO.Stream required**

**options OfficeIMO.OneNote.Markdown.OneNoteMarkdownExportOptions? = null optional**

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

Returns

`Task<OfficeConversionReport>`

`public static async Task<OfficeConversionReport> SaveAsMarkdownAsync(OneNoteNotebook notebook, string path, OneNoteMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasmarkdownasync-officeimo-onenote-onenotenotebook-string-officeimo-onenote-markdown-onenotemarkdownexportoptions-threading-cancellationtoken)

Asynchronously writes the notebook's Markdown projection as UTF-8.

Parameters

**notebook OfficeIMO.OneNote.OneNoteNotebook required**

**path string required**

**options OfficeIMO.OneNote.Markdown.OneNoteMarkdownExportOptions? = null optional**

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

Returns

`Task<OfficeConversionReport>`

`public static async Task<OfficeConversionReport> SaveAsMarkdownAsync(OneNoteNotebook notebook, Stream stream, OneNoteMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasmarkdownasync-officeimo-onenote-onenotenotebook-io-stream-officeimo-onenote-markdown-onenotemarkdownexportoptions-threading-cancellationtoken)

Asynchronously writes the notebook's Markdown projection as UTF-8.

Parameters

**notebook OfficeIMO.OneNote.OneNoteNotebook required**

**stream System.IO.Stream required**

**options OfficeIMO.OneNote.Markdown.OneNoteMarkdownExportOptions? = null optional**

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

Returns

`Task<OfficeConversionReport>`

ToMarkdown 4 overloads

`public static MarkdownDocument ToMarkdown(OneNoteSection section, OneNoteMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-tomarkdown-officeimo-onenote-onenotesection-officeimo-onenote-markdown-onenotemarkdownexportoptions-threading-cancellationtoken)

[OneNoteMarkdownConverterExtensions.Conversion.cs:10](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Markdown/OneNoteMarkdownConverterExtensions.Conversion.cs#L10)

Converts a section to a Markdown document.

Parameters

**section OfficeIMO.OneNote.OneNoteSection required**

**options OfficeIMO.OneNote.Markdown.OneNoteMarkdownExportOptions? = null optional**

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

Returns

`MarkdownDocument`

`public static MarkdownDocument ToMarkdown(OneNoteSection section, OneNoteMarkdownExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default)` [#](#method-tomarkdown-officeimo-onenote-onenotesection-officeimo-onenote-markdown-onenotemarkdownexportoptions-officeimo-officeconversionreport-threading-cancellationtoken)

[OneNoteMarkdownConverterExtensions.Conversion.cs:15](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Markdown/OneNoteMarkdownConverterExtensions.Conversion.cs#L15)

Converts a section to a Markdown document and returns the completed conversion report.

Parameters

**section OfficeIMO.OneNote.OneNoteSection required**

**options OfficeIMO.OneNote.Markdown.OneNoteMarkdownExportOptions? required**

**report OfficeIMO.OfficeConversionReport required**

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

Returns

`MarkdownDocument`

`public static MarkdownDocument ToMarkdown(OneNoteNotebook notebook, OneNoteMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-tomarkdown-officeimo-onenote-onenotenotebook-officeimo-onenote-markdown-onenotemarkdownexportoptions-threading-cancellationtoken)

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

Converts a notebook to a Markdown document.

Parameters

**notebook OfficeIMO.OneNote.OneNoteNotebook required**

**options OfficeIMO.OneNote.Markdown.OneNoteMarkdownExportOptions? = null optional**

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

Returns

`MarkdownDocument`

`public static MarkdownDocument ToMarkdown(OneNoteNotebook notebook, OneNoteMarkdownExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default)` [#](#method-tomarkdown-officeimo-onenote-onenotenotebook-officeimo-onenote-markdown-onenotemarkdownexportoptions-officeimo-officeconversionreport-threading-cancellationtoken)

[OneNoteMarkdownConverterExtensions.Conversion.cs:77](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Markdown/OneNoteMarkdownConverterExtensions.Conversion.cs#L77)

Converts a notebook to a Markdown document and returns the completed conversion report.

Parameters

**notebook OfficeIMO.OneNote.OneNoteNotebook required**

**options OfficeIMO.OneNote.Markdown.OneNoteMarkdownExportOptions? required**

**report OfficeIMO.OfficeConversionReport required**

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

Returns

`MarkdownDocument`

ToMarkdownAsync 2 overloads

`public static Task<OfficeConversionResult<MarkdownDocument>> ToMarkdownAsync(OneNoteSection section, OneNoteMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-tomarkdownasync-officeimo-onenote-onenotesection-officeimo-onenote-markdown-onenotemarkdownexportoptions-threading-cancellationtoken)

[OneNoteMarkdownConverterExtensions.Conversion.cs:27](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.OneNote.Markdown/OneNoteMarkdownConverterExtensions.Conversion.cs#L27)

Converts a section to a Markdown document, returning the value and report together.

Parameters

**section OfficeIMO.OneNote.OneNoteSection required**

**options OfficeIMO.OneNote.Markdown.OneNoteMarkdownExportOptions? = null optional**

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

Returns

`Task<OfficeConversionResult<MarkdownDocument>>`

`public static Task<OfficeConversionResult<MarkdownDocument>> ToMarkdownAsync(OneNoteNotebook notebook, OneNoteMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-tomarkdownasync-officeimo-onenote-onenotenotebook-officeimo-onenote-markdown-onenotemarkdownexportoptions-threading-cancellationtoken)

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

Converts a notebook to a Markdown document, returning the value and report together.

Parameters

**notebook OfficeIMO.OneNote.OneNoteNotebook required**

**options OfficeIMO.OneNote.Markdown.OneNoteMarkdownExportOptions? = null optional**

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

Returns

`Task<OfficeConversionResult<MarkdownDocument>>`

## 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:4E189CCB7814935B56D6D32E667AD0A27D1F343661D1C2565777AF515070E579 -->
