Get Started

API Reference

Class

WordDocumentComparer

Edit on GitHub
Namespace OfficeIMO.Word
Assembly OfficeIMO.Word
Source OfficeIMO.Word/WordDocumentComparer/WordDocumentComparer.cs:13
Modifiers static

Provides simple comparison between two Word documents.

Inheritance

  • Object
  • WordDocumentComparer

Methods

public static WordDocument Compare(String sourcePath, String targetPath) #
OfficeIMO.Word/WordDocumentComparer/WordDocumentComparer.cs:13
Returns: WordDocument

Compares two documents and produces a new document with revision marks.

Parameters

sourcePath System.String requiredposition: 0
Path to the original document.
targetPath System.String requiredposition: 1
Path to the modified document.

Returns

Document containing revision marks highlighting differences.

CompareStructure 3 overloads
public static WordComparisonResult CompareStructure(String sourcePath, String targetPath) #
OfficeIMO.Word/WordDocumentComparer/WordDocumentComparer.Structured.cs:39
Returns: WordComparisonResult

Compares two documents and returns a machine-readable summary of structural differences.

Parameters

sourcePath System.String requiredposition: 0
Path to the original document.
targetPath System.String requiredposition: 1
Path to the modified document.

Returns

A deterministic comparison result that can be used for review reports and automation.

public static WordComparisonResult CompareStructure(String sourcePath, String targetPath, WordComparisonOptions options) #
OfficeIMO.Word/WordDocumentComparer/WordDocumentComparer.Structured.cs:50
Returns: WordComparisonResult

Compares two documents and returns a machine-readable summary of structural differences.

Parameters

sourcePath System.String requiredposition: 0
Path to the original document.
targetPath System.String requiredposition: 1
Path to the modified document.
options OfficeIMO.Word.WordComparisonOptions requiredposition: 2
Optional comparison switches for text normalization and feature families.

Returns

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") #
OfficeIMO.Word/WordDocumentComparer/WordDocumentComparer.Structured.cs:73
Returns: WordComparisonResult

Compares two already-loaded documents without writing them to disk and returns a machine-readable summary.

Parameters

source OfficeIMO.Word.WordDocument requiredposition: 0
Original document.
target OfficeIMO.Word.WordDocument requiredposition: 1
Modified document.
options OfficeIMO.Word.WordComparisonOptions = null optionalposition: 2
Optional comparison switches for text normalization and feature families.
sourceLabel System.String = "source" optionalposition: 3
Logical source label included in reports.
targetLabel System.String = "target" optionalposition: 4
Logical target label included in reports.

Returns

A deterministic comparison result that can be used for review reports and automation.

public static WordComparisonResult CreateRedlineDocument(String sourcePath, String targetPath, String outputPath, WordComparisonRedlineOptions options = null) #
OfficeIMO.Word/WordDocumentComparer/WordDocumentComparer.Redline.cs:16
Returns: WordComparisonResult

Compares two documents and writes a DOCX redline document using the configured redline mode.

Parameters

sourcePath System.String requiredposition: 0
Path to the original document.
targetPath System.String requiredposition: 1
Path to the modified document.
outputPath System.String requiredposition: 2
Path where the redline DOCX should be written.
options OfficeIMO.Word.WordComparisonRedlineOptions = null optionalposition: 3
Optional redline and comparison settings.

Returns

The structured comparison result used to generate the redline document.