WordRtfWorkflowExtensions
OfficeIMO.Word.Rtf
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
- target OfficeIMO.Rtf.RtfDocument
- options OfficeIMO.Word.WordComparisonOptions? = null
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
- textToFind string
- textToReplace string
- comparison System.StringComparison = OrdinalIgnoreCase
Returns
RtfWordWorkflowResult<int>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
- textToFind string
- textToReplace string
- comparison System.StringComparison = OrdinalIgnoreCase
Returns
RtfWordWorkflowResult<int>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
- values System.Collections.Generic.IDictionary<string, string>
- removeFields bool = true
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
- values System.Collections.Generic.IDictionary<string, string>
- removeFields bool = true
public static RtfWordWorkflowResult<int> MergeResult(RtfDocument document, RtfDocument source) #Appends another RTF document through the OfficeIMO.Word merge engine.
Parameters
- document OfficeIMO.Rtf.RtfDocument
- source OfficeIMO.Rtf.RtfDocument
Returns
RtfWordWorkflowResult<int>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
- options OfficeIMO.Word.WordFieldUpdateOptions? = null
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
- options OfficeIMO.Word.WordFieldUpdateOptions? = null