Foxit PDF SDK
FoxitPDFSDKPython3.Comparison Class Reference
Inheritance diagram for FoxitPDFSDKPython3.Comparison:
FoxitPDFSDKPython3.Base

Public Member Functions

def Comparison (other)
 Constructor, with another comparison object.
More...
 
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...
 

Static Public Attributes

 e_CompareTypeAll = _fsdk.Comparison_e_CompareTypeAll
 Compare all content. This value should be used alone.

 
 e_CompareTypeAnnotation = _fsdk.Comparison_e_CompareTypeAnnotation
 Compare annotation only.

 
 e_CompareTypeText = _fsdk.Comparison_e_CompareTypeText
 Compare text only.

 

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.

Constructor & Destructor Documentation

◆ Comparison()

def FoxitPDFSDKPython3.Comparison.Comparison (   other)

Constructor, with another comparison object.

Parameters
[in]otherAnother comparison object.

Member Function Documentation

◆ DoCompare()

def FoxitPDFSDKPython3.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 FoxitPDFSDKPython3.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 FoxitPDFSDKPython3.PDFDoc.GetPageCount for compared document.
[in]compare_flagsCompare type which specifies what to be compared in PDF pages. Please refer to values starting from FoxitPDFSDKPython3.Comparison.e_CompareTypeAll and this can be one or combination of some of these values.
Returns
A FoxitPDFSDKPython3.CompareResults object.

◆ GenerateComparedDoc()

def FoxitPDFSDKPython3.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 FoxitPDFSDKPython3.Comparison.e_CompareTypeAll and this can be one or a combination of these values.
Returns
A FoxitPDFSDKPython3.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 FoxitPDFSDKPython3.Comparison.e_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 FoxitPDFSDKPython3.PDFDoc object which represents the output comparison PDF document.

◆ IsEmpty()

def FoxitPDFSDKPython3.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.