RichEditDocumentServerExtensions.Compare(Document, Document, CompareDocumentOptions) Method

Compares the current document with another document. Returns the document with revisions. Allows you to specify comparison options.

Namespace : DevExpress.XtraRichEdit

Assembly : DevExpress.Docs.v25.2.dll

NuGet Package : DevExpress.Document.Processor

csharp

public static Document Compare(
    this Document original,
    Document revisedDocument,
    CompareDocumentOptions options
)

<ExtensionAttribute>
Public Shared Function Compare(
    original As Document,
    revisedDocument As Document,
    options As CompareDocumentOptions
) As Document

Parameters

Name	Type	Description
original	Document

The original document.

| | revisedDocument | Document |

The document that should be compared to the original document.

| | options | CompareDocumentOptions |

An object that contains comparison options.

Returns

Type	Description
Document

The document with revisions.

Example

The following code snippet specifies comparison settings and passes the CompareDocumentOptions instance as the Compare method parameter:

C#
VB.NET

csharp

using DevExpress.XtraRichEdit;
using DevExpress.XtraRichEdit.API.Native;

var wordProcessor = new RichEditDocumentServer();
var wordProcessorRevised = new RichEditDocumentServer();
wordProcessor.LoadDocument("C:\\Documents\\sample text original.docx");
wordProcessorRevised.LoadDocument("C:\\Documents\\sample text revised.docx");

CompareDocumentOptions options = new CompareDocumentOptions();
options.CompareFormatting = false;
options.CompareCaseChanges = false;
options.ComparisonLevel = ComparisonLevel.Word;
options.Author = "Nancy Doe";
options.DateTime = DateTime.Now;

Document document = wordProcessor.Document.Compare(wordProcessorRevised.Document, options);
document.SaveDocument("comparison.docx", DocumentFormat.Docx);

Imports DevExpress.XtraRichEdit
Imports DevExpress.XtraRichEdit.API.Native

Private wordProcessor = New RichEditDocumentServer()
Private wordProcessorRevised = New RichEditDocumentServer()
wordProcessor.LoadDocument("C:\Documents\sample text original.docx")
wordProcessorRevised.LoadDocument("C:\Documents\sample text revised.docx")

Dim options As New CompareDocumentOptions()
options.CompareFormatting = False
options.CompareCaseChanges = False
options.ComparisonLevel = ComparisonLevel.Word
options.Author = "Nancy Doe"
options.DateTime = DateTime.Now

Dim document As Document = wordProcessor.Document.Compare(wordProcessorRevised.Document, options)
document.SaveDocument("comparison.docx", DocumentFormat.Docx)