Skip to content

Page::Compare method

The Compare method allows you to compare two pages returning the differences.

Overloads

Compare(Page, CompareSettings) The Compare method allows you to compare two pages returning the differences.
Compare(Page, System.Drawing.RectangleF, CompareSettings) The Compare method allows you to compare two pages, applying margins, returning the differences.
Compare(Page, System.Drawing.RectangleF, System.Drawing.RectangleF, CompareSettings) The Compare method allows you to compare two pages, applying margins, returning the differences.

Compare(Page, CompareSettings)

Prototype

CompareResults Compare(Page otherPage, CompareSettings settings)

CompareResults Compare(Page otherPage, CompareSettings settings) throws IGRException;

def Compare(self, otherPage: Page, settings: CompareSettings) -> CompareResults

CompareResults Compare(Page otherPage, CompareSettings settings)

Parameters

otherPage: Page : Provide the other Page to compare.

settings: CompareSettings : Provide the settings that control the compare logic.

Return value

CompareResults : A new instance of a CompareResults interface.

Compare(Page, System.Drawing.RectangleF, CompareSettings)

Prototype

CompareResults Compare(Page otherPage, System.Drawing.RectangleF margins, CompareSettings settings)

CompareResults Compare(Page otherPage, System.Drawing.RectangleF margins, CompareSettings settings)

Parameters

otherPage: Page : Provide the other Page to compare.

margins: System.Drawing.RectangleF : The margins to apply to both pages.

settings: CompareSettings : Provide the settings that control the compare logic.

Return value

CompareResults : A new instance of a CompareResults interface.

Compare(Page, System.Drawing.RectangleF, System.Drawing.RectangleF, CompareSettings)

Prototype

CompareResults Compare(Page otherPage, System.Drawing.RectangleF leftMargins, System.Drawing.RectangleF rightMargins, CompareSettings settings)

CompareResults Compare(Page otherPage, System.Drawing.RectangleF leftMargins, System.Drawing.RectangleF rightMargins, CompareSettings settings)

Parameters

otherPage: Page : Provide the other Page to compare.

leftMargins: System.Drawing.RectangleF : The margins to apply to the left/original page.

rightMargins: System.Drawing.RectangleF : The margins to apply to the right/revised page.

settings: CompareSettings : Provide the settings that control the compare logic.

Return value

CompareResults : A new instance of a CompareResults interface.

Sample Code

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
using Hyland.DocumentFilters;

var api = new Hyland.DocumentFilters.Api();
api.Initialize("License Code", ".");

using (var doc1 = api.OpenExtractor(GetTestFilename("original.docx"), OpenMode.Paginated))
using (var doc2 = api.OpenExtractor(GetTestFilename("revision.docx"), OpenMode.Paginated))
using (var page1 = doc1.GetPage(0))
using (var page2 = doc2.GetPage(0))
using (var compare = page1.Compare(page2))
{
    while (compare.MoveNext())
    {
        var diff = compare.Current;
        // work with diff...
    }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
#include <DocumentFilters.h>
#include <string.h>
#include <string>

#define UCS2(src) reinterpret_cast<const IGR_UCS2 *>(std::u16string(src).c_str())

int main(int argc, char **argv)
{
    Instance_Status_Block isb = {0};
    Error_Control_Block ecb = {0};
    IGR_SHORT df;
    IGR_LONG caps, type, pageCount = 0;
    IGR_HDOC doc1_handle = 0, doc2_handle = 0; 
    IGR_HPAGE doc1_page1_handle = 0, doc2_page1_handle = 0;
    IGR_HTEXTCOMPARE compare = 0;

    strncpy(isb.Licensee_ID1, "License Code", sizeof(isb.Licensee_ID1) - 1);
    Init_Instance(0, ".", &isb, &df, &ecb);

    if ((res = IGR_Open_File_Ex(UCS2(u"original.doc"), IGR_FORMAT_IMAGE, UCS2(u""), &caps, &type, &doc1_handle, &ecb)) == IGR_OK
        && (res = IGR_Open_File_Ex(UCS2(u"revised.doc"), IGR_FORMAT_IMAGE, UCS2(u""), &caps, &type, &doc2_handle, &ecb)) == IGR_OK
        && (res = IGR_Open_Page(doc1_handle, 0, &doc1_page1_handle, &ecb)) == IGR_OK
        && (res = IGR_Open_Page(doc2_handle, 0, &doc2_page1_handle, &ecb)) == IGR_OK)
    {
        IGR_Text_Compare_Settings settings = { sizeof(IGR_Text_Compare_Settings) };
        IGR_Compare_Documents_Difference diff = { sizeof(IGR_Compare_Documents_Difference) };

        if ((ret = IGR_Text_Compare_Pages(doc1_page1_handle, nullptr, doc2_page1_handle, nullptr, &settings, &compare, &ecb)) == IGR_OK)
        {
            while (IGR_Text_Compare_Next(compare, &diff, &ecb) == IGR_OK)
            {
                // ... work with diff object

                IGR_Text_Compare_Difference_Dispose(&diff, &ecb);
            }

            IGR_Text_Compare_Close(compare, &ecb);
        }
    }

    if (doc1_page1_handle)
        IGR_Close_Page(doc1_page1_handle, &ecb);
    if (doc2_page1_handle)
        IGR_Close_Page(doc2_page1_handle, &ecb);
    if (doc1_handle)
        IGR_Close_File(doc1_handle, &ecb);
    if (doc2_handle)
        IGR_Close_File(doc2_handle, &ecb);
    return 0;
}

See Also