Word document comparison options Leave feedback

GroupDocs.Comparison provides the WordCompareOptions class for configuring comparison of Word documents (.doc, .docx, .rtf, and other word-processing formats). It inherits from CompareOptions and adds Word-specific properties — most notably the DisplayMode property, which controls how detected changes are written into the result document.

The DisplayMode property accepts one of two values from the WordCompareOptions.ComparisonDisplayMode enumeration:

• Revisions — changes are emitted as native Word revision (track-changes) markup. The result opens in Microsoft Word with the Review → Accept / Reject controls ready.
• Highlight — inserted, deleted, and modified text is rendered with inline colour highlights directly in the document body. No track-changes metadata is added.

using GroupDocs.Comparison;
using GroupDocs.Comparison.Options;
// ...

using (Comparer comparer = new Comparer("source.docx"))
{
    comparer.Add("target.docx");

    WordCompareOptions options = new WordCompareOptions
    {
        DisplayMode = WordCompareOptions.ComparisonDisplayMode.Revisions
    };

    comparer.Compare("result.docx", options);
}

The result:

Revisions mode

using GroupDocs.Comparison;
using GroupDocs.Comparison.Options;
// ...

using (Comparer comparer = new Comparer("source.docx"))
{
    comparer.Add("target.docx");

    WordCompareOptions options = new WordCompareOptions
    {
        DisplayMode = WordCompareOptions.ComparisonDisplayMode.Highlight
    };

    comparer.Compare("result.docx", options);
}

The result:

Highlight mode

For a step-by-step walkthrough comparing both modes side by side, see the related tutorial: Word Comparison in .NET: Revision Track vs Highlight Modes.

Set DetectStyleChanges to true to include formatting differences (bold, font size, colour, etc.) alongside textual edits.

using (Comparer comparer = new Comparer("source.docx"))
{
    comparer.Add("target.docx");

    WordCompareOptions options = new WordCompareOptions
    {
        DisplayMode = WordCompareOptions.ComparisonDisplayMode.Revisions,
        DetectStyleChanges = true
    };

    comparer.Compare("result.docx", options);
}

Set HeaderFootersComparison to true to include header and footer content in the comparison.

using (Comparer comparer = new Comparer("source.docx"))
{
    comparer.Add("target.docx");

    WordCompareOptions options = new WordCompareOptions
    {
        HeaderFootersComparison = true
    };

    comparer.Compare("result.docx", options);
}

Set MarkLineBreaks to true to visually mark paragraph (line) breaks that differ between documents.

using (Comparer comparer = new Comparer("source.docx"))
{
    comparer.Add("target.docx");

    WordCompareOptions options = new WordCompareOptions
    {
        MarkLineBreaks = true
    };

    comparer.Compare("result.docx", options);
}

The properties below are also available on WordCompareOptions. Several of them are documented in dedicated articles — follow the links for details:

• CompareBookmarks — compare bookmarks in the source and target documents. See Compare bookmarks in Word documents.
• CompareVariableProperty — compare document variable properties (e.g. DOCVARIABLE fields). See Compare document properties and variables.
• CompareDocumentProperty — compare built-in and custom document properties. See Compare document properties and variables.
• RevisionAuthorName — author name stamped on revisions when DisplayMode = Revisions. See Setting author of changes.
• ShowRevisions — controls whether revision markup remains visible in the result. See Show Revisions.
• LeaveGaps — leave empty lines in place of inserted or deleted content to preserve layout.

All CompareOptions base properties — InsertedItemStyle, DeletedItemStyle, ChangedItemStyle, SensitivityOfComparison, GenerateSummaryPage, and others — are also available on WordCompareOptions.

• WordCompareOptions API reference
• Word Comparison in .NET: Revision Track vs Highlight Modes (blog tutorial)
• Compare bookmarks in Word documents
• Show Revisions
• Setting author of changes