# WordRtfConverterExtensions

Extension methods for converting between WordDocument and RtfDocument.

Class 

`OfficeIMO.Word.Rtf`

**Namespace**

`OfficeIMO.Word.Rtf`

**Assembly**

`OfficeIMO.Word.Rtf`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[WordRtfConverterExtensions.Conversion.cs:10](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.Rtf/WordRtfConverterExtensions.Conversion.cs#L10)

**Modifiers**

static

Extension methods for converting between WordDocument and RtfDocument.

## Inheritance

- object
- WordRtfConverterExtensions

Filter members 

Show inherited

## Methods

SaveAsRtf 2 overloads

`public static OfficeConversionReport SaveAsRtf(WordDocument document, string path, WordRtfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasrtf-officeimo-word-worddocument-string-officeimo-word-rtf-wordrtfexportoptions-threading-cancellationtoken)

[WordRtfConverterExtensions.Conversion.cs:34](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.Rtf/WordRtfConverterExtensions.Conversion.cs#L34)

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

Parameters

**document OfficeIMO.Word.WordDocument required**

**path string required**

**options OfficeIMO.Word.Rtf.WordRtfExportOptions? = null optional**

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

Returns

`OfficeConversionReport`

`public static OfficeConversionReport SaveAsRtf(WordDocument document, Stream stream, WordRtfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasrtf-officeimo-word-worddocument-io-stream-officeimo-word-rtf-wordrtfexportoptions-threading-cancellationtoken)

[WordRtfConverterExtensions.Conversion.cs:41](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.Rtf/WordRtfConverterExtensions.Conversion.cs#L41)

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

Parameters

**document OfficeIMO.Word.WordDocument required**

**stream System.IO.Stream required**

**options OfficeIMO.Word.Rtf.WordRtfExportOptions? = null optional**

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

Returns

`OfficeConversionReport`

SaveAsRtfAsync 2 overloads

`public static async Task<OfficeConversionReport> SaveAsRtfAsync(WordDocument document, string path, WordRtfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasrtfasync-officeimo-word-worddocument-string-officeimo-word-rtf-wordrtfexportoptions-threading-cancellationtoken)

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

Parameters

**document OfficeIMO.Word.WordDocument required**

**path string required**

**options OfficeIMO.Word.Rtf.WordRtfExportOptions? = null optional**

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

Returns

`Task<OfficeConversionReport>`

`public static async Task<OfficeConversionReport> SaveAsRtfAsync(WordDocument document, Stream stream, WordRtfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasrtfasync-officeimo-word-worddocument-io-stream-officeimo-word-rtf-wordrtfexportoptions-threading-cancellationtoken)

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

Parameters

**document OfficeIMO.Word.WordDocument required**

**stream System.IO.Stream required**

**options OfficeIMO.Word.Rtf.WordRtfExportOptions? = null optional**

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

Returns

`Task<OfficeConversionReport>`

SaveAsWord 4 overloads

`public static OfficeConversionReport SaveAsWord(RtfDocument document, string path, RtfWordExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasword-officeimo-rtf-rtfdocument-string-officeimo-word-rtf-rtfwordexportoptions-threading-cancellationtoken)

[WordRtfConverterExtensions.Conversion.cs:95](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.Rtf/WordRtfConverterExtensions.Conversion.cs#L95)

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

Parameters

**document OfficeIMO.Rtf.RtfDocument required**

**path string required**

**options OfficeIMO.Word.Rtf.RtfWordExportOptions? = null optional**

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

Returns

`OfficeConversionReport`

`public static OfficeConversionReport SaveAsWord(RtfDocument document, Stream stream, RtfWordExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasword-officeimo-rtf-rtfdocument-io-stream-officeimo-word-rtf-rtfwordexportoptions-threading-cancellationtoken)

[WordRtfConverterExtensions.Conversion.cs:102](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.Rtf/WordRtfConverterExtensions.Conversion.cs#L102)

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.Word.Rtf.RtfWordExportOptions? = null optional**

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

Returns

`OfficeConversionReport`

`public static OfficeConversionReport SaveAsWord(RtfReadResult readResult, string path, RtfWordExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasword-officeimo-rtf-rtfreadresult-string-officeimo-word-rtf-rtfwordexportoptions-threading-cancellationtoken)

[WordRtfConverterExtensions.Conversion.cs:156](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.Rtf/WordRtfConverterExtensions.Conversion.cs#L156)

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

Parameters

**readResult OfficeIMO.Rtf.RtfReadResult required**

**path string required**

**options OfficeIMO.Word.Rtf.RtfWordExportOptions? = null optional**

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

Returns

`OfficeConversionReport`

`public static OfficeConversionReport SaveAsWord(RtfReadResult readResult, Stream stream, RtfWordExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveasword-officeimo-rtf-rtfreadresult-io-stream-officeimo-word-rtf-rtfwordexportoptions-threading-cancellationtoken)

[WordRtfConverterExtensions.Conversion.cs:163](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.Rtf/WordRtfConverterExtensions.Conversion.cs#L163)

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

Parameters

**readResult OfficeIMO.Rtf.RtfReadResult required**

**stream System.IO.Stream required**

**options OfficeIMO.Word.Rtf.RtfWordExportOptions? = null optional**

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

Returns

`OfficeConversionReport`

SaveAsWordAsync 4 overloads

`public static async Task<OfficeConversionReport> SaveAsWordAsync(RtfDocument document, string path, RtfWordExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveaswordasync-officeimo-rtf-rtfdocument-string-officeimo-word-rtf-rtfwordexportoptions-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.Word.Rtf.RtfWordExportOptions? = null optional**

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

Returns

`Task<OfficeConversionReport>`

`public static async Task<OfficeConversionReport> SaveAsWordAsync(RtfDocument document, Stream stream, RtfWordExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveaswordasync-officeimo-rtf-rtfdocument-io-stream-officeimo-word-rtf-rtfwordexportoptions-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.Word.Rtf.RtfWordExportOptions? = null optional**

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

Returns

`Task<OfficeConversionReport>`

`public static async Task<OfficeConversionReport> SaveAsWordAsync(RtfReadResult readResult, string path, RtfWordExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveaswordasync-officeimo-rtf-rtfreadresult-string-officeimo-word-rtf-rtfwordexportoptions-threading-cancellationtoken)

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

Parameters

**readResult OfficeIMO.Rtf.RtfReadResult required**

**path string required**

**options OfficeIMO.Word.Rtf.RtfWordExportOptions? = null optional**

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

Returns

`Task<OfficeConversionReport>`

`public static async Task<OfficeConversionReport> SaveAsWordAsync(RtfReadResult readResult, Stream stream, RtfWordExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-saveaswordasync-officeimo-rtf-rtfreadresult-io-stream-officeimo-word-rtf-rtfwordexportoptions-threading-cancellationtoken)

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

Parameters

**readResult OfficeIMO.Rtf.RtfReadResult required**

**stream System.IO.Stream required**

**options OfficeIMO.Word.Rtf.RtfWordExportOptions? = null optional**

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

Returns

`Task<OfficeConversionReport>`

ToRtf 2 overloads

`public static RtfDocument ToRtf(WordDocument document, WordRtfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-tortf-officeimo-word-worddocument-officeimo-word-rtf-wordrtfexportoptions-threading-cancellationtoken)

[WordRtfConverterExtensions.Conversion.cs:10](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.Rtf/WordRtfConverterExtensions.Conversion.cs#L10)

Converts a Word document to the semantic RTF model.

Parameters

**document OfficeIMO.Word.WordDocument required**

**options OfficeIMO.Word.Rtf.WordRtfExportOptions? = null optional**

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

Returns

`RtfDocument`

`public static RtfDocument ToRtf(WordDocument document, WordRtfExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default)` [#](#method-tortf-officeimo-word-worddocument-officeimo-word-rtf-wordrtfexportoptions-officeimo-officeconversionreport-threading-cancellationtoken)

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

Converts a Word document to the semantic RTF model and returns the completed conversion report.

Parameters

**document OfficeIMO.Word.WordDocument required**

**options OfficeIMO.Word.Rtf.WordRtfExportOptions? required**

**report OfficeIMO.OfficeConversionReport required**

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

Returns

`RtfDocument`

`public static Task<OfficeConversionResult<RtfDocument>> ToRtfAsync(WordDocument document, WordRtfExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-tortfasync-officeimo-word-worddocument-officeimo-word-rtf-wordrtfexportoptions-threading-cancellationtoken)

[WordRtfConverterExtensions.Conversion.cs:27](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.Rtf/WordRtfConverterExtensions.Conversion.cs#L27)

Converts a Word document to the semantic RTF model, returning the value and report together.

Parameters

**document OfficeIMO.Word.WordDocument required**

**options OfficeIMO.Word.Rtf.WordRtfExportOptions? = null optional**

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

Returns

`Task<OfficeConversionResult<RtfDocument>>`

ToWord 4 overloads

`public static WordDocument ToWord(RtfDocument document, RtfWordExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-toword-officeimo-rtf-rtfdocument-officeimo-word-rtf-rtfwordexportoptions-threading-cancellationtoken)

[WordRtfConverterExtensions.Conversion.cs:71](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.Rtf/WordRtfConverterExtensions.Conversion.cs#L71)

Converts a semantic RTF document to a Word document.

Parameters

**document OfficeIMO.Rtf.RtfDocument required**

**options OfficeIMO.Word.Rtf.RtfWordExportOptions? = null optional**

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

Returns

`WordDocument`

`public static WordDocument ToWord(RtfDocument document, RtfWordExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default)` [#](#method-toword-officeimo-rtf-rtfdocument-officeimo-word-rtf-rtfwordexportoptions-officeimo-officeconversionreport-threading-cancellationtoken)

[WordRtfConverterExtensions.Conversion.cs:76](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.Rtf/WordRtfConverterExtensions.Conversion.cs#L76)

Converts a semantic RTF document to a Word document and returns the completed conversion report.

Parameters

**document OfficeIMO.Rtf.RtfDocument required**

**options OfficeIMO.Word.Rtf.RtfWordExportOptions? required**

**report OfficeIMO.OfficeConversionReport required**

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

Returns

`WordDocument`

`public static WordDocument ToWord(RtfReadResult readResult, RtfWordExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-toword-officeimo-rtf-rtfreadresult-officeimo-word-rtf-rtfwordexportoptions-threading-cancellationtoken)

[WordRtfConverterExtensions.Conversion.cs:132](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.Rtf/WordRtfConverterExtensions.Conversion.cs#L132)

Converts a parsed RTF read result, including its read diagnostics, to a Word document.

Parameters

**readResult OfficeIMO.Rtf.RtfReadResult required**

**options OfficeIMO.Word.Rtf.RtfWordExportOptions? = null optional**

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

Returns

`WordDocument`

`public static WordDocument ToWord(RtfReadResult readResult, RtfWordExportOptions? options, out OfficeConversionReport report, CancellationToken cancellationToken = default)` [#](#method-toword-officeimo-rtf-rtfreadresult-officeimo-word-rtf-rtfwordexportoptions-officeimo-officeconversionreport-threading-cancellationtoken)

[WordRtfConverterExtensions.Conversion.cs:137](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.Rtf/WordRtfConverterExtensions.Conversion.cs#L137)

Converts a parsed RTF read result, including its read diagnostics, to a Word document and returns the completed conversion report.

Parameters

**readResult OfficeIMO.Rtf.RtfReadResult required**

**options OfficeIMO.Word.Rtf.RtfWordExportOptions? required**

**report OfficeIMO.OfficeConversionReport required**

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

Returns

`WordDocument`

ToWordAsync 2 overloads

`public static Task<OfficeConversionResult<WordDocument>> ToWordAsync(RtfDocument document, RtfWordExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-towordasync-officeimo-rtf-rtfdocument-officeimo-word-rtf-rtfwordexportoptions-threading-cancellationtoken)

[WordRtfConverterExtensions.Conversion.cs:88](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.Rtf/WordRtfConverterExtensions.Conversion.cs#L88)

Converts a semantic RTF document to a Word document, returning the value and report together.

Parameters

**document OfficeIMO.Rtf.RtfDocument required**

**options OfficeIMO.Word.Rtf.RtfWordExportOptions? = null optional**

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

Returns

`Task<OfficeConversionResult<WordDocument>>`

`public static Task<OfficeConversionResult<WordDocument>> ToWordAsync(RtfReadResult readResult, RtfWordExportOptions? options = null, CancellationToken cancellationToken = default)` [#](#method-towordasync-officeimo-rtf-rtfreadresult-officeimo-word-rtf-rtfwordexportoptions-threading-cancellationtoken)

[WordRtfConverterExtensions.Conversion.cs:149](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.Rtf/WordRtfConverterExtensions.Conversion.cs#L149)

Converts a parsed RTF read result, including its read diagnostics, to a Word document, returning the value and report together.

Parameters

**readResult OfficeIMO.Rtf.RtfReadResult required**

**options OfficeIMO.Word.Rtf.RtfWordExportOptions? = 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:9CB3403685A211DAA3903C406E51B0BB134ECDE8B074E50E1A6BEFAAB14E643E -->
