Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

WordRtfWorkflowExtensions

OfficeIMO.Word.Rtf

Namespace
OfficeIMO.Word.Rtf
Assembly
OfficeIMO.Word.Rtf
Source revision
ba882f6b0d07 with working tree changes
Modifiers
static

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

Inheritance

  • object
  • WordRtfWorkflowExtensions

Methods

public static RtfWordWorkflowResult<WordComparisonResult> CompareResult(RtfDocument source, RtfDocument target, WordComparisonOptions? options = null) #

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
FindAndReplaceResult 2 overloads
public static RtfWordWorkflowResult<int> FindAndReplaceResult(RtfDocument document, string textToFind, string textToReplace, StringComparison comparison = OrdinalIgnoreCase) #

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
public static RtfWordWorkflowResult<int> FindAndReplaceResult(RtfReadResult document, string textToFind, string textToReplace, StringComparison comparison = OrdinalIgnoreCase) #

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
MailMergeResult 2 overloads
public static RtfWordWorkflowResult<WordMailMergeTemplateInspection> MailMergeResult(RtfDocument template, IDictionary<string, string> values, bool removeFields = true) #

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
public static RtfWordWorkflowResult<WordMailMergeTemplateInspection> MailMergeResult(RtfReadResult template, IDictionary<string, string> values, bool removeFields = true) #

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
public static RtfWordWorkflowResult<int> MergeResult(RtfDocument document, RtfDocument source) #

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

Parameters

document OfficeIMO.Rtf.RtfDocument required
source OfficeIMO.Rtf.RtfDocument required
UpdateFieldsResult 2 overloads
public static RtfWordWorkflowResult<WordFieldUpdateReport> UpdateFieldsResult(RtfDocument document, WordFieldUpdateOptions? options = null) #

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

Parameters

document OfficeIMO.Rtf.RtfDocument required
options OfficeIMO.Word.WordFieldUpdateOptions? = null optional
public static RtfWordWorkflowResult<WordFieldUpdateReport> UpdateFieldsResult(RtfReadResult document, WordFieldUpdateOptions? options = null) #

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

Parameters

document OfficeIMO.Rtf.RtfReadResult required
options OfficeIMO.Word.WordFieldUpdateOptions? = null optional