API Reference
Class
WordRtfWorkflowExtensions
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) #Returns:
RtfWordWorkflowResult<WordComparisonResult>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
FindAndReplaceResult 2 overloads
public static RtfWordWorkflowResult<Int32> FindAndReplaceResult(RtfDocument document, String textToFind, String textToReplace, StringComparison comparison = OrdinalIgnoreCase) #Returns:
RtfWordWorkflowResult<Int32>Runs the OfficeIMO.Word cross-run find/replace engine and returns normalized RTF.
Parameters
- arg1 OfficeIMO.Rtf.RtfDocument
- arg2 System.String
- arg3 System.String
- arg4 System.StringComparison = OrdinalIgnoreCase
public static RtfWordWorkflowResult<Int32> FindAndReplaceResult(RtfReadResult document, String textToFind, String textToReplace, StringComparison comparison = OrdinalIgnoreCase) #Returns:
RtfWordWorkflowResult<Int32>Runs find/replace from a parsed RTF result, retaining parser diagnostics.
Parameters
- arg1 OfficeIMO.Rtf.RtfReadResult
- arg2 System.String
- arg3 System.String
- arg4 System.StringComparison = OrdinalIgnoreCase
MailMergeResult 2 overloads
public static RtfWordWorkflowResult<WordMailMergeTemplateInspection> MailMergeResult(RtfDocument template, IDictionary<String, String> values, Boolean removeFields = true) #Returns:
RtfWordWorkflowResult<WordMailMergeTemplateInspection>Executes Word mail merge against an RTF template and converts the result back to RTF.
Parameters
- arg1 OfficeIMO.Rtf.RtfDocument
- arg2 System.Collections.Generic.IDictionary{System.String,System.String}
- arg3 System.Boolean = true
public static RtfWordWorkflowResult<WordMailMergeTemplateInspection> MailMergeResult(RtfReadResult template, IDictionary<String, String> values, Boolean removeFields = true) #Returns:
RtfWordWorkflowResult<WordMailMergeTemplateInspection>Executes Word mail merge from a parsed RTF result, retaining parser diagnostics.
Parameters
- arg1 OfficeIMO.Rtf.RtfReadResult
- arg2 System.Collections.Generic.IDictionary{System.String,System.String}
- arg3 System.Boolean = true
public static RtfWordWorkflowResult<Int32> MergeResult(RtfDocument document, RtfDocument source) #Returns:
RtfWordWorkflowResult<Int32>Appends another RTF document through the OfficeIMO.Word merge engine.
Parameters
- document OfficeIMO.Rtf.RtfDocument
- source OfficeIMO.Rtf.RtfDocument
UpdateFieldsResult 2 overloads
public static RtfWordWorkflowResult<WordFieldUpdateReport> UpdateFieldsResult(RtfDocument document, WordFieldUpdateOptions options = null) #Returns:
RtfWordWorkflowResult<WordFieldUpdateReport>Updates deterministic fields through OfficeIMO.Word and returns its detailed update report.
Parameters
- arg1 OfficeIMO.Rtf.RtfDocument
- arg2 OfficeIMO.Word.WordFieldUpdateOptions = null
public static RtfWordWorkflowResult<WordFieldUpdateReport> UpdateFieldsResult(RtfReadResult document, WordFieldUpdateOptions options = null) #Returns:
RtfWordWorkflowResult<WordFieldUpdateReport>Updates fields from a parsed RTF result, retaining parser diagnostics.
Parameters
- arg1 OfficeIMO.Rtf.RtfReadResult
- arg2 OfficeIMO.Word.WordFieldUpdateOptions = null
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object