WordDocumentComparer
OfficeIMO.Word
Provides simple comparison between two Word documents.
Inheritance
- object
- WordDocumentComparer
Methods
public static WordDocument Compare(string sourcePath, string targetPath) #Compares two documents and produces a new document with revision marks.
Parameters
- sourcePath string
- Path to the original document.
- targetPath string
- Path to the modified document.
public static WordComparisonResult CompareStructure(string sourcePath, string targetPath) #Compares two documents and returns a machine-readable summary of structural differences.
Parameters
- sourcePath string
- Path to the original document.
- targetPath string
- Path to the modified document.
Returns
WordComparisonResult A deterministic comparison result that can be used for review reports and automation.public static WordComparisonResult CompareStructure(string sourcePath, string targetPath, WordComparisonOptions? options) #Compares two documents and returns a machine-readable summary of structural differences.
Parameters
- sourcePath string
- Path to the original document.
- targetPath string
- Path to the modified document.
- options OfficeIMO.Word.WordComparisonOptions?
- Optional comparison switches for text normalization and feature families.
Returns
WordComparisonResult A deterministic comparison result that can be used for review reports and automation.public static WordComparisonResult CompareStructure(WordDocument source, WordDocument target, WordComparisonOptions? options = null, string sourceLabel = "source", string targetLabel = "target") #Compares two already-loaded documents without writing them to disk and returns a machine-readable summary.
Parameters
- source OfficeIMO.Word.WordDocument
- Original document.
- target OfficeIMO.Word.WordDocument
- Modified document.
- options OfficeIMO.Word.WordComparisonOptions? = null
- Optional comparison switches for text normalization and feature families.
- sourceLabel string = "source"
- Logical source label included in reports.
- targetLabel string = "target"
- Logical target label included in reports.
Returns
WordComparisonResult A deterministic comparison result that can be used for review reports and automation.public static WordComparisonResult CreateRedlineDocument(string sourcePath, string targetPath, string outputPath) #Writes a DOCX redline for two paths using the default comparison and redline settings.
Parameters
- sourcePath string
- targetPath string
- outputPath string
Returns
WordComparisonResultpublic static WordComparisonResult CreateRedlineDocument(string sourcePath, string targetPath, string outputPath, WordComparisonRedlineOptions? options) #Compares two documents and writes a DOCX redline document using the configured redline mode.
Parameters
- sourcePath string
- Path to the original document.
- targetPath string
- Path to the modified document.
- outputPath string
- Path where the redline DOCX should be written.
- options OfficeIMO.Word.WordComparisonRedlineOptions?
- Optional redline and comparison settings.
public static WordComparisonResult CreateRedlineDocument(WordDocument source, WordDocument target, string outputPath, WordComparisonRedlineOptions? options) #Writes a redline from the current loaded models, including unsaved edits, without saving, reopening or disposing either input.
Parameters
- source OfficeIMO.Word.WordDocument
- Caller-owned original document, already authenticated if encrypted.
- target OfficeIMO.Word.WordDocument
- Caller-owned modified document, already authenticated if encrypted.
- outputPath string
- Destination distinct from either model's associated file.
- options OfficeIMO.Word.WordComparisonRedlineOptions?
- Native comparison and redline settings. Null selects defaults; supplied settings are not modified.