# RtfMarkdownConverterExtensions

Semantic conversion between OfficeIMO RTF and Markdown document models.

Class 

`OfficeIMO.Rtf.Markdown`

**Namespace**

`OfficeIMO.Rtf.Markdown`

**Assembly**

`OfficeIMO.Rtf.Markdown`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[RtfMarkdownConverterExtensions.cs:32](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf.Markdown/RtfMarkdownConverterExtensions.cs#L32)

**Modifiers**

static

Semantic conversion between OfficeIMO RTF and Markdown document models.

## Inheritance

- object
- RtfMarkdownConverterExtensions

Filter members 

Show inherited

## Methods

SaveAsMarkdown 2 overloads

`public static OfficeConversionReport SaveAsMarkdown(RtfDocument document, string path, RtfMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasmarkdown-officeimo-rtf-rtfdocument-string-officeimo-rtf-markdown-rtfmarkdownexportoptions-threading-cancellationtoken)

[RtfMarkdownConverterExtensions.cs:56](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf.Markdown/RtfMarkdownConverterExtensions.cs#L56)

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

Parameters

**document OfficeIMO.Rtf.RtfDocument required**

**path string required**

**options OfficeIMO.Rtf.Markdown.RtfMarkdownExportOptions? = null optional**

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

Returns

`OfficeConversionReport`

`public static OfficeConversionReport SaveAsMarkdown(RtfDocument document, Stream stream, RtfMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasmarkdown-officeimo-rtf-rtfdocument-io-stream-officeimo-rtf-markdown-rtfmarkdownexportoptions-threading-cancellationtoken)

[RtfMarkdownConverterExtensions.cs:63](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf.Markdown/RtfMarkdownConverterExtensions.cs#L63)

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

Parameters

**document OfficeIMO.Rtf.RtfDocument required**

**stream System.IO.Stream required**

**options OfficeIMO.Rtf.Markdown.RtfMarkdownExportOptions? = null optional**

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

Returns

`OfficeConversionReport`

SaveAsMarkdownAsync 2 overloads

`public static async Task<OfficeConversionReport> SaveAsMarkdownAsync(RtfDocument document, string path, RtfMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasmarkdownasync-officeimo-rtf-rtfdocument-string-officeimo-rtf-markdown-rtfmarkdownexportoptions-threading-cancellationtoken)

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

Parameters

**document OfficeIMO.Rtf.RtfDocument required**

**path string required**

**options OfficeIMO.Rtf.Markdown.RtfMarkdownExportOptions? = null optional**

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

Returns

`Task<OfficeConversionReport>`

`public static async Task<OfficeConversionReport> SaveAsMarkdownAsync(RtfDocument document, Stream stream, RtfMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasmarkdownasync-officeimo-rtf-rtfdocument-io-stream-officeimo-rtf-markdown-rtfmarkdownexportoptions-threading-cancellationtoken)

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

Parameters

**document OfficeIMO.Rtf.RtfDocument required**

**stream System.IO.Stream required**

**options OfficeIMO.Rtf.Markdown.RtfMarkdownExportOptions? = null optional**

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

Returns

`Task<OfficeConversionReport>`

SaveAsRtf 2 overloads

`public static OfficeConversionReport SaveAsRtf(MarkdownDocument markdown, string path, MarkdownRtfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasrtf-officeimo-markdown-markdowndocument-string-officeimo-rtf-markdown-markdownrtfexportoptions-threading-cancellationtoken)

[RtfMarkdownConverterExtensions.cs:117](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf.Markdown/RtfMarkdownConverterExtensions.cs#L117)

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

Parameters

**markdown OfficeIMO.Markdown.MarkdownDocument required**

**path string required**

**options OfficeIMO.Rtf.Markdown.MarkdownRtfExportOptions? = null optional**

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

Returns

`OfficeConversionReport`

`public static OfficeConversionReport SaveAsRtf(MarkdownDocument markdown, Stream stream, MarkdownRtfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasrtf-officeimo-markdown-markdowndocument-io-stream-officeimo-rtf-markdown-markdownrtfexportoptions-threading-cancellationtoken)

[RtfMarkdownConverterExtensions.cs:124](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf.Markdown/RtfMarkdownConverterExtensions.cs#L124)

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

Parameters

**markdown OfficeIMO.Markdown.MarkdownDocument required**

**stream System.IO.Stream required**

**options OfficeIMO.Rtf.Markdown.MarkdownRtfExportOptions? = null optional**

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

Returns

`OfficeConversionReport`

SaveAsRtfAsync 2 overloads

`public static async Task<OfficeConversionReport> SaveAsRtfAsync(MarkdownDocument markdown, string path, MarkdownRtfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasrtfasync-officeimo-markdown-markdowndocument-string-officeimo-rtf-markdown-markdownrtfexportoptions-threading-cancellationtoken)

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

Parameters

**markdown OfficeIMO.Markdown.MarkdownDocument required**

**path string required**

**options OfficeIMO.Rtf.Markdown.MarkdownRtfExportOptions? = null optional**

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

Returns

`Task<OfficeConversionReport>`

`public static async Task<OfficeConversionReport> SaveAsRtfAsync(MarkdownDocument markdown, Stream stream, MarkdownRtfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasrtfasync-officeimo-markdown-markdowndocument-io-stream-officeimo-rtf-markdown-markdownrtfexportoptions-threading-cancellationtoken)

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

Parameters

**markdown OfficeIMO.Markdown.MarkdownDocument required**

**stream System.IO.Stream required**

**options OfficeIMO.Rtf.Markdown.MarkdownRtfExportOptions? = null optional**

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

Returns

`Task<OfficeConversionReport>`

ToMarkdown 2 overloads

`public static MarkdownDocument ToMarkdown(RtfDocument document, RtfMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-tomarkdown-officeimo-rtf-rtfdocument-officeimo-rtf-markdown-rtfmarkdownexportoptions-threading-cancellationtoken)

[RtfMarkdownConverterExtensions.cs:32](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf.Markdown/RtfMarkdownConverterExtensions.cs#L32)

Converts an RTF document into a Markdown document model.

Parameters

**document OfficeIMO.Rtf.RtfDocument required**

**options OfficeIMO.Rtf.Markdown.RtfMarkdownExportOptions? = null optional**

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

Returns

`MarkdownDocument`

`public static MarkdownDocument ToMarkdown(RtfDocument document, RtfMarkdownExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default)` [#](#method-tomarkdown-officeimo-rtf-rtfdocument-officeimo-rtf-markdown-rtfmarkdownexportoptions-officeimo-officeconversionreport-threading-cancellationtoken)

[RtfMarkdownConverterExtensions.cs:37](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf.Markdown/RtfMarkdownConverterExtensions.cs#L37)

Converts an RTF document into a Markdown document model and returns the completed conversion report.

Parameters

**document OfficeIMO.Rtf.RtfDocument required**

**options OfficeIMO.Rtf.Markdown.RtfMarkdownExportOptions? required**

**report OfficeIMO.OfficeConversionReport required**

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

Returns

`MarkdownDocument`

`public static Task<OfficeConversionResult<MarkdownDocument>> ToMarkdownAsync(RtfDocument document, RtfMarkdownExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-tomarkdownasync-officeimo-rtf-rtfdocument-officeimo-rtf-markdown-rtfmarkdownexportoptions-threading-cancellationtoken)

[RtfMarkdownConverterExtensions.cs:49](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf.Markdown/RtfMarkdownConverterExtensions.cs#L49)

Converts an RTF document into a Markdown document model, returning the value and report together.

Parameters

**document OfficeIMO.Rtf.RtfDocument required**

**options OfficeIMO.Rtf.Markdown.RtfMarkdownExportOptions? = null optional**

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

Returns

`Task<OfficeConversionResult<MarkdownDocument>>`

ToRtf 2 overloads

`public static RtfDocument ToRtf(MarkdownDocument markdown, MarkdownRtfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-tortf-officeimo-markdown-markdowndocument-officeimo-rtf-markdown-markdownrtfexportoptions-threading-cancellationtoken)

[RtfMarkdownConverterExtensions.cs:93](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf.Markdown/RtfMarkdownConverterExtensions.cs#L93)

Converts a Markdown document into an RTF document model.

Parameters

**markdown OfficeIMO.Markdown.MarkdownDocument required**

**options OfficeIMO.Rtf.Markdown.MarkdownRtfExportOptions? = null optional**

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

Returns

`RtfDocument`

`public static RtfDocument ToRtf(MarkdownDocument markdown, MarkdownRtfExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default)` [#](#method-tortf-officeimo-markdown-markdowndocument-officeimo-rtf-markdown-markdownrtfexportoptions-officeimo-officeconversionreport-threading-cancellationtoken)

[RtfMarkdownConverterExtensions.cs:98](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf.Markdown/RtfMarkdownConverterExtensions.cs#L98)

Converts a Markdown document into an RTF document model and returns the completed conversion report.

Parameters

**markdown OfficeIMO.Markdown.MarkdownDocument required**

**options OfficeIMO.Rtf.Markdown.MarkdownRtfExportOptions? required**

**report OfficeIMO.OfficeConversionReport required**

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

Returns

`RtfDocument`

`public static Task<OfficeConversionResult<RtfDocument>> ToRtfAsync(MarkdownDocument markdown, MarkdownRtfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-tortfasync-officeimo-markdown-markdowndocument-officeimo-rtf-markdown-markdownrtfexportoptions-threading-cancellationtoken)

[RtfMarkdownConverterExtensions.cs:110](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf.Markdown/RtfMarkdownConverterExtensions.cs#L110)

Converts a Markdown document into an RTF document model, returning the value and report together.

Parameters

**markdown OfficeIMO.Markdown.MarkdownDocument required**

**options OfficeIMO.Rtf.Markdown.MarkdownRtfExportOptions? = null optional**

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

Returns

`Task<OfficeConversionResult<RtfDocument>>`

## 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:7E523811DD54305DBF0ECF32FE6EB22258D515F9FC29346E8BFCE7D9776F4749 -->
