# WordRtfWorkflowExtensions

Thin RTF workflow routes over the reusable OfficeIMO.Word engines.

Class 

`OfficeIMO.Word.Rtf`

**Namespace**

`OfficeIMO.Word.Rtf`

**Assembly**

`OfficeIMO.Word.Rtf`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

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

**Modifiers**

static

Thin RTF workflow routes over the reusable OfficeIMO.Word engines.

## Inheritance

- object
- WordRtfWorkflowExtensions

Filter members 

Show inherited

## Methods

`public static RtfWordWorkflowResult<WordComparisonResult> CompareResult(RtfDocument source, RtfDocument target, WordComparisonOptions? options = null)` [#](#method-compareresult-officeimo-rtf-rtfdocument-officeimo-rtf-rtfdocument-officeimo-word-wordcomparisonoptions)

[WordRtfWorkflowExtensions.cs:111](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.Rtf/WordRtfWorkflowExtensions.cs#L111)

Compares two RTF documents using the machine-readable OfficeIMO.Word comparison engine.

Parameters

**source OfficeIMO.Rtf.RtfDocument required**

**target OfficeIMO.Rtf.RtfDocument required**

**options OfficeIMO.Word.WordComparisonOptions? = null optional**

Returns

`RtfWordWorkflowResult<WordComparisonResult>`

FindAndReplaceResult 2 overloads

`public static RtfWordWorkflowResult<int> FindAndReplaceResult(RtfDocument document, string textToFind, string textToReplace, StringComparison comparison = OrdinalIgnoreCase)` [#](#method-findandreplaceresult-officeimo-rtf-rtfdocument-string-string-stringcomparison)

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

Runs the OfficeIMO.Word cross-run find/replace engine and returns normalized RTF.

Parameters

**document OfficeIMO.Rtf.RtfDocument required**

**textToFind string required**

**textToReplace string required**

**comparison System.StringComparison = OrdinalIgnoreCase optional**

Returns

`RtfWordWorkflowResult<int>`

`public static RtfWordWorkflowResult<int> FindAndReplaceResult(RtfReadResult document, string textToFind, string textToReplace, StringComparison comparison = OrdinalIgnoreCase)` [#](#method-findandreplaceresult-officeimo-rtf-rtfreadresult-string-string-stringcomparison)

[WordRtfWorkflowExtensions.cs:53](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.Rtf/WordRtfWorkflowExtensions.cs#L53)

Runs find/replace from a parsed RTF result, retaining parser diagnostics.

Parameters

**document OfficeIMO.Rtf.RtfReadResult required**

**textToFind string required**

**textToReplace string required**

**comparison System.StringComparison = OrdinalIgnoreCase optional**

Returns

`RtfWordWorkflowResult<int>`

MailMergeResult 2 overloads

`public static RtfWordWorkflowResult<WordMailMergeTemplateInspection> MailMergeResult(RtfDocument template, IDictionary<string, string> values, bool removeFields = true)` [#](#method-mailmergeresult-officeimo-rtf-rtfdocument-collections-generic-idictionary-system-string-system-string-boolean)

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

Executes Word mail merge against an RTF template and converts the result back to RTF.

Parameters

**template OfficeIMO.Rtf.RtfDocument required**

**values System.Collections.Generic.IDictionary<string, string> required**

**removeFields bool = true optional**

Returns

`RtfWordWorkflowResult<WordMailMergeTemplateInspection>`

`public static RtfWordWorkflowResult<WordMailMergeTemplateInspection> MailMergeResult(RtfReadResult template, IDictionary<string, string> values, bool removeFields = true)` [#](#method-mailmergeresult-officeimo-rtf-rtfreadresult-collections-generic-idictionary-system-string-system-string-boolean)

[WordRtfWorkflowExtensions.cs:25](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.Rtf/WordRtfWorkflowExtensions.cs#L25)

Executes Word mail merge from a parsed RTF result, retaining parser diagnostics.

Parameters

**template OfficeIMO.Rtf.RtfReadResult required**

**values System.Collections.Generic.IDictionary<string, string> required**

**removeFields bool = true optional**

Returns

`RtfWordWorkflowResult<WordMailMergeTemplateInspection>`

`public static RtfWordWorkflowResult<int> MergeResult(RtfDocument document, RtfDocument source)` [#](#method-mergeresult-officeimo-rtf-rtfdocument-officeimo-rtf-rtfdocument)

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

Appends another RTF document through the OfficeIMO.Word merge engine.

Parameters

**document OfficeIMO.Rtf.RtfDocument required**

**source OfficeIMO.Rtf.RtfDocument required**

Returns

`RtfWordWorkflowResult<int>`

UpdateFieldsResult 2 overloads

`public static RtfWordWorkflowResult<WordFieldUpdateReport> UpdateFieldsResult(RtfDocument document, WordFieldUpdateOptions? options = null)` [#](#method-updatefieldsresult-officeimo-rtf-rtfdocument-officeimo-word-wordfieldupdateoptions)

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

Updates deterministic fields through OfficeIMO.Word and returns its detailed update report.

Parameters

**document OfficeIMO.Rtf.RtfDocument required**

**options OfficeIMO.Word.WordFieldUpdateOptions? = null optional**

Returns

`RtfWordWorkflowResult<WordFieldUpdateReport>`

`public static RtfWordWorkflowResult<WordFieldUpdateReport> UpdateFieldsResult(RtfReadResult document, WordFieldUpdateOptions? options = null)` [#](#method-updatefieldsresult-officeimo-rtf-rtfreadresult-officeimo-word-wordfieldupdateoptions)

[WordRtfWorkflowExtensions.cs:85](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Word.Rtf/WordRtfWorkflowExtensions.cs#L85)

Updates fields from a parsed RTF result, retaining parser diagnostics.

Parameters

**document OfficeIMO.Rtf.RtfReadResult required**

**options OfficeIMO.Word.WordFieldUpdateOptions? = null optional**

Returns

`RtfWordWorkflowResult<WordFieldUpdateReport>`

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