# HtmlMarkdownConverterExtensions

Extension helpers for converting HTML into OfficeIMO.Markdown content.

Class 

`OfficeIMO.Markdown.Html`

**Namespace**

`OfficeIMO.Markdown.Html`

**Assembly**

`OfficeIMO.Markdown.Html`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

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

**Modifiers**

static

Extension helpers for converting HTML into OfficeIMO.Markdown content.

## Inheritance

- object
- HtmlMarkdownConverterExtensions

Filter members 

Show inherited

## Methods

SaveAsMarkdown 2 overloads

`public static OfficeConversionReport SaveAsMarkdown(HtmlConversionDocument document, string path, HtmlMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasmarkdown-officeimo-html-htmlconversiondocument-string-officeimo-markdown-html-htmlmarkdownexportoptions-threading-cancellationtoken)

[HtmlMarkdownConverterExtensions.Conversion.cs:29](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Markdown.Html/HtmlMarkdownConverterExtensions.Conversion.cs#L29)

Saves converted Markdown with completed-stage findings.

Parameters

**document OfficeIMO.Html.HtmlConversionDocument required**

**path string required**

**options OfficeIMO.Markdown.Html.HtmlMarkdownExportOptions? = null optional**

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

Returns

`OfficeConversionReport`

`public static OfficeConversionReport SaveAsMarkdown(HtmlConversionDocument document, Stream stream, HtmlMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasmarkdown-officeimo-html-htmlconversiondocument-io-stream-officeimo-markdown-html-htmlmarkdownexportoptions-threading-cancellationtoken)

[HtmlMarkdownConverterExtensions.Conversion.cs:61](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Markdown.Html/HtmlMarkdownConverterExtensions.Conversion.cs#L61)

Saves converted Markdown with completed-stage findings.

Parameters

**document OfficeIMO.Html.HtmlConversionDocument required**

**stream System.IO.Stream required**

**options OfficeIMO.Markdown.Html.HtmlMarkdownExportOptions? = null optional**

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

Returns

`OfficeConversionReport`

SaveAsMarkdownAsync 2 overloads

`public static async Task<OfficeConversionReport> SaveAsMarkdownAsync(HtmlConversionDocument document, string path, HtmlMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasmarkdownasync-officeimo-html-htmlconversiondocument-string-officeimo-markdown-html-htmlmarkdownexportoptions-threading-cancellationtoken)

Saves converted Markdown with completed-stage findings.

Parameters

**document OfficeIMO.Html.HtmlConversionDocument required**

**path string required**

**options OfficeIMO.Markdown.Html.HtmlMarkdownExportOptions? = null optional**

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

Returns

`Task<OfficeConversionReport>`

`public static async Task<OfficeConversionReport> SaveAsMarkdownAsync(HtmlConversionDocument document, Stream stream, HtmlMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasmarkdownasync-officeimo-html-htmlconversiondocument-io-stream-officeimo-markdown-html-htmlmarkdownexportoptions-threading-cancellationtoken)

Saves converted Markdown with completed-stage findings.

Parameters

**document OfficeIMO.Html.HtmlConversionDocument required**

**stream System.IO.Stream required**

**options OfficeIMO.Markdown.Html.HtmlMarkdownExportOptions? = null optional**

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

Returns

`Task<OfficeConversionReport>`

ToMarkdown 2 overloads

`public static MarkdownDocument ToMarkdown(HtmlConversionDocument document, HtmlMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-tomarkdown-officeimo-html-htmlconversiondocument-officeimo-markdown-html-htmlmarkdownexportoptions-threading-cancellationtoken)

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

Converts prepared HTML to a Markdown document.

Parameters

**document OfficeIMO.Html.HtmlConversionDocument required**

**options OfficeIMO.Markdown.Html.HtmlMarkdownExportOptions? = null optional**

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

Returns

`MarkdownDocument`

`public static MarkdownDocument ToMarkdown(HtmlConversionDocument document, HtmlMarkdownExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default)` [#](#method-tomarkdown-officeimo-html-htmlconversiondocument-officeimo-markdown-html-htmlmarkdownexportoptions-officeimo-officeconversionreport-threading-cancellationtoken)

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

Converts prepared HTML to Markdown with completed-stage findings.

Parameters

**document OfficeIMO.Html.HtmlConversionDocument required**

**options OfficeIMO.Markdown.Html.HtmlMarkdownExportOptions? required**

**report OfficeIMO.OfficeConversionReport required**

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

Returns

`MarkdownDocument`

`public static async Task<OfficeConversionResult<MarkdownDocument>> ToMarkdownAsync(HtmlConversionDocument document, HtmlMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-tomarkdownasync-officeimo-html-htmlconversiondocument-officeimo-markdown-html-htmlmarkdownexportoptions-threading-cancellationtoken)

Converts HTML to Markdown and returns the model and report together.

Parameters

**document OfficeIMO.Html.HtmlConversionDocument required**

**options OfficeIMO.Markdown.Html.HtmlMarkdownExportOptions? = 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:33E0D8CD97D0691827C25501500002D139D78BB4ECE04A18FA357BF491E4874B -->
