Foxit PDF SDK
fsdk.Comparison Class Reference

Public Member Functions

def DoCompare (base_page_index, compared_page_index, compare_flags)
 Compare a PDF page of base document with a PDF page in compared document. "base document" and "compared document" means the PDF documents objects that are used to construct current object.
More...
 
def GenerateComparedDoc (compare_flags)
 Compare the base document with the compared document (which are used to construct current object) and then generate a PDF document as the comparison result.
More...
 
def IsEmpty ()
 Check whether current object is empty or not.
More...
 

Detailed Description

This class can be used to compare one PDF file (as "base document") with another PDF file (as "compared document") page by page.

Member Function Documentation

◆ DoCompare()

def fsdk.Comparison.DoCompare (   base_page_index,
  compared_page_index,
  compare_flags 
)

Compare a PDF page of base document with a PDF page in compared document. "base document" and "compared document" means the PDF documents objects that are used to construct current object.

Parameters
[in]base_page_indexPage index in base document. Valid range: from 0 to (base_page_count-1). base_page_count is returned by function fsdk.PDFDoc.GetPageCount for base document.
[in]compared_page_indexPage index in compared document. Valid range: from 0 to (compared_page_count-1). compared_page_count is returned by function fsdk.PDFDoc.GetPageCount for compared document.
[in]compare_flagsCompare type which specifies what to be compared in PDF pages. Please refer to values starting from fsdk.ComparisonE_CompareTypeAll and this can be one or combination of some of these values.
Returns
A fsdk.CompareResults object.

◆ GenerateComparedDoc()

def fsdk.Comparison.GenerateComparedDoc (   compare_flags)

Compare the base document with the compared document (which are used to construct current object) and then generate a PDF document as the comparison result.

Comparing the contents of two PDF documents and generating a new PDF document can take a long time.

Parameters
[in]compare_flagsCompare type which specifies what to be compared in PDF pages. Please refer to values starting from fsdk.ComparisonE_CompareTypeAll and this can be one or a combination of these values.
Returns
A fsdk.PDFDoc object which represents the output comparison PDF document.

Comparing the contents of two PDF documents and generating a new PDF document can take a long time.

Parameters
[in]compare_flagsCompare type which specifies what to be compared in PDF pages. Please refer to values starting from fsdk.ComparisonE_CompareTypeAll and this can be one or a combination of these values.
[in]is_show_all_layersA boolean value used to decide whether to show all comparison result layers or not. true means that all comparison result layers are shown by default, while false means only "Text" and "Images" comparison result layers are shown by default.
Returns
A fsdk.PDFDoc object which represents the output comparison PDF document.

◆ IsEmpty()

def fsdk.Comparison.IsEmpty ( )

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
true means current object is empty, while false means not.