# WordMarkdownConverterExtensions

Extension methods enabling Markdown conversions for WordDocument instances.

Class 

`OfficeIMO.Word.Markdown`

**Namespace**

`OfficeIMO.Word.Markdown`

**Assembly**

`OfficeIMO.Word.Markdown`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

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

**Modifiers**

static

Extension methods enabling Markdown conversions for WordDocument instances.

## Inheritance

- object
- WordMarkdownConverterExtensions

Filter members 

Show inherited

## Methods

SaveAsMarkdown 2 overloads

`public static OfficeConversionReport SaveAsMarkdown(WordDocument document, string path, WordMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasmarkdown-officeimo-word-worddocument-string-officeimo-word-markdown-wordmarkdownexportoptions-threading-cancellationtoken)

[WordMarkdownConverterExtensions.Conversion.cs:42](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.Markdown/WordMarkdownConverterExtensions.Conversion.cs#L42)

Saves converted Markdown content with a completed-stage report.

Parameters

**document OfficeIMO.Word.WordDocument required**

**path string required**

**options OfficeIMO.Word.Markdown.WordMarkdownExportOptions? = null optional**

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

Returns

`OfficeConversionReport`

`public static OfficeConversionReport SaveAsMarkdown(WordDocument document, Stream stream, WordMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasmarkdown-officeimo-word-worddocument-io-stream-officeimo-word-markdown-wordmarkdownexportoptions-threading-cancellationtoken)

[WordMarkdownConverterExtensions.Conversion.cs:68](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.Markdown/WordMarkdownConverterExtensions.Conversion.cs#L68)

Saves converted Markdown content with a completed-stage report.

Parameters

**document OfficeIMO.Word.WordDocument required**

**stream System.IO.Stream required**

**options OfficeIMO.Word.Markdown.WordMarkdownExportOptions? = null optional**

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

Returns

`OfficeConversionReport`

SaveAsMarkdownAsync 2 overloads

`public static async Task<OfficeConversionReport> SaveAsMarkdownAsync(WordDocument document, string path, WordMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasmarkdownasync-officeimo-word-worddocument-string-officeimo-word-markdown-wordmarkdownexportoptions-threading-cancellationtoken)

Saves converted Markdown content with a completed-stage report.

Parameters

**document OfficeIMO.Word.WordDocument required**

**path string required**

**options OfficeIMO.Word.Markdown.WordMarkdownExportOptions? = null optional**

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

Returns

`Task<OfficeConversionReport>`

`public static async Task<OfficeConversionReport> SaveAsMarkdownAsync(WordDocument document, Stream stream, WordMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasmarkdownasync-officeimo-word-worddocument-io-stream-officeimo-word-markdown-wordmarkdownexportoptions-threading-cancellationtoken)

Saves converted Markdown content with a completed-stage report.

Parameters

**document OfficeIMO.Word.WordDocument required**

**stream System.IO.Stream required**

**options OfficeIMO.Word.Markdown.WordMarkdownExportOptions? = null optional**

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

Returns

`Task<OfficeConversionReport>`

SaveAsWord 2 overloads

`public static OfficeConversionReport SaveAsWord(MarkdownDocument document, string path, MarkdownWordExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasword-officeimo-markdown-markdowndocument-string-officeimo-word-markdown-markdownwordexportoptions-threading-cancellationtoken)

[WordMarkdownConverterExtensions.Conversion.cs:124](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.Markdown/WordMarkdownConverterExtensions.Conversion.cs#L124)

Saves converted Word content with a completed-stage report.

Parameters

**document OfficeIMO.Markdown.MarkdownDocument required**

**path string required**

**options OfficeIMO.Word.Markdown.MarkdownWordExportOptions? = null optional**

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

Returns

`OfficeConversionReport`

`public static OfficeConversionReport SaveAsWord(MarkdownDocument document, Stream stream, MarkdownWordExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasword-officeimo-markdown-markdowndocument-io-stream-officeimo-word-markdown-markdownwordexportoptions-threading-cancellationtoken)

[WordMarkdownConverterExtensions.Conversion.cs:150](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.Markdown/WordMarkdownConverterExtensions.Conversion.cs#L150)

Saves converted Word content with a completed-stage report.

Parameters

**document OfficeIMO.Markdown.MarkdownDocument required**

**stream System.IO.Stream required**

**options OfficeIMO.Word.Markdown.MarkdownWordExportOptions? = null optional**

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

Returns

`OfficeConversionReport`

SaveAsWordAsync 2 overloads

`public static async Task<OfficeConversionReport> SaveAsWordAsync(MarkdownDocument document, string path, MarkdownWordExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveaswordasync-officeimo-markdown-markdowndocument-string-officeimo-word-markdown-markdownwordexportoptions-threading-cancellationtoken)

Saves converted Word content with a completed-stage report.

Parameters

**document OfficeIMO.Markdown.MarkdownDocument required**

**path string required**

**options OfficeIMO.Word.Markdown.MarkdownWordExportOptions? = null optional**

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

Returns

`Task<OfficeConversionReport>`

`public static async Task<OfficeConversionReport> SaveAsWordAsync(MarkdownDocument document, Stream stream, MarkdownWordExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveaswordasync-officeimo-markdown-markdowndocument-io-stream-officeimo-word-markdown-markdownwordexportoptions-threading-cancellationtoken)

Saves converted Word content with a completed-stage report.

Parameters

**document OfficeIMO.Markdown.MarkdownDocument required**

**stream System.IO.Stream required**

**options OfficeIMO.Word.Markdown.MarkdownWordExportOptions? = null optional**

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

Returns

`Task<OfficeConversionReport>`

ToMarkdown 2 overloads

`public static MarkdownDocument ToMarkdown(WordDocument document, WordMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-tomarkdown-officeimo-word-worddocument-officeimo-word-markdown-wordmarkdownexportoptions-threading-cancellationtoken)

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

Converts Word to a Markdown document.

Parameters

**document OfficeIMO.Word.WordDocument required**

**options OfficeIMO.Word.Markdown.WordMarkdownExportOptions? = null optional**

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

Returns

`MarkdownDocument`

`public static MarkdownDocument ToMarkdown(WordDocument document, WordMarkdownExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default)` [#](#method-tomarkdown-officeimo-word-worddocument-officeimo-word-markdown-wordmarkdownexportoptions-officeimo-officeconversionreport-threading-cancellationtoken)

[WordMarkdownConverterExtensions.Conversion.cs:19](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.Markdown/WordMarkdownConverterExtensions.Conversion.cs#L19)

Converts Word to Markdown and returns completed-stage findings.

Parameters

**document OfficeIMO.Word.WordDocument required**

**options OfficeIMO.Word.Markdown.WordMarkdownExportOptions? required**

**report OfficeIMO.OfficeConversionReport required**

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

Returns

`MarkdownDocument`

`public static async Task<OfficeConversionResult<MarkdownDocument>> ToMarkdownAsync(WordDocument document, WordMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-tomarkdownasync-officeimo-word-worddocument-officeimo-word-markdown-wordmarkdownexportoptions-threading-cancellationtoken)

Converts Word to Markdown with its completed-stage report.

Parameters

**document OfficeIMO.Word.WordDocument required**

**options OfficeIMO.Word.Markdown.WordMarkdownExportOptions? = null optional**

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

Returns

`Task<OfficeConversionResult<MarkdownDocument>>`

ToWord 2 overloads

`public static WordDocument ToWord(MarkdownDocument document, MarkdownWordExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-toword-officeimo-markdown-markdowndocument-officeimo-word-markdown-markdownwordexportoptions-threading-cancellationtoken)

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

Converts Markdown to a Word document.

Parameters

**document OfficeIMO.Markdown.MarkdownDocument required**

**options OfficeIMO.Word.Markdown.MarkdownWordExportOptions? = null optional**

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

Returns

`WordDocument`

`public static WordDocument ToWord(MarkdownDocument document, MarkdownWordExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default)` [#](#method-toword-officeimo-markdown-markdowndocument-officeimo-word-markdown-markdownwordexportoptions-officeimo-officeconversionreport-threading-cancellationtoken)

[WordMarkdownConverterExtensions.Conversion.cs:100](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.Markdown/WordMarkdownConverterExtensions.Conversion.cs#L100)

Converts Markdown to Word and returns completed-stage findings.

Parameters

**document OfficeIMO.Markdown.MarkdownDocument required**

**options OfficeIMO.Word.Markdown.MarkdownWordExportOptions? required**

**report OfficeIMO.OfficeConversionReport required**

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

Returns

`WordDocument`

`public static async Task<OfficeConversionResult<WordDocument>> ToWordAsync(MarkdownDocument document, MarkdownWordExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-towordasync-officeimo-markdown-markdowndocument-officeimo-word-markdown-markdownwordexportoptions-threading-cancellationtoken)

Converts Markdown to Word with its completed-stage report.

Parameters

**document OfficeIMO.Markdown.MarkdownDocument required**

**options OfficeIMO.Word.Markdown.MarkdownWordExportOptions? = null optional**

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

Returns

`Task<OfficeConversionResult<WordDocument>>`

## 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:0147965A28961C0B563E6B3365B1C888F33C3996ACD683586D59691F5F39984B -->
