Foxit PDF SDK

Public Member Functions | Static Public Attributes | List of all members
FSDK.Comparison Class Reference

## Public Member Functions
| constructor (base_doc, compared_doc)
| Constructor, from PDF document object. More...
| 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...
| 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...
| GenerateComparedDoc (compare_flags, is_show_all_layers)
| 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...
| IsEmpty ()
| Check whether current object is empty or not. More...

## Static Public Attributes
static | e_CompareTypeAll
| Enumeration for compare type flags. More...
static | e_CompareTypeAnnotation
| Compare annotation only.
static | 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.

## Member Function Documentation

## ◆ constructor()

FSDK.Comparison.constructor | ( | base_doc | ,
|  | compared_doc |
| ) |  |

Constructor, from PDF document object.

Parameters

  [in] | base_doc | A valid PDF document object as base document.
  [in] | compared_doc | A valid PDF document object as compared document.

Note
  If module "Comparison" is not defined in the license information which is used in function FSDK.Library.Initialize, that means user has no right in using compare related functions and this constructor will throw exception FSDK.e_ErrNoComparisonModuleRight.

## ◆ DoCompare()

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_index | Page 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_index | Page 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_flags | Compare type which specifies what to be compared in PDF pages. Please refer to values starting from FSDK.Comparison.e_CompareTypeAll and this can be one or combination of some of these values.

Returns
  A FSDK.CompareResults object.

## ◆ GenerateComparedDoc() [1/2]

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_flags | Compare type which specifies what to be compared in PDF pages. Please refer to values starting from FSDK.Comparison.e_CompareTypeAll and this can be one or a combination of these values.

Returns
  A FSDK.PDFDoc object which represents the output comparison PDF document.

## ◆ GenerateComparedDoc() [2/2]

FSDK.Comparison.GenerateComparedDoc | ( | compare_flags | ,
|  | is_show_all_layers |
| ) |  |

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_flags | Compare type which specifies what to be compared in PDF pages. Please refer to values starting from FSDK.Comparison.e_CompareTypeAll and this can be one or a combination of these values.
  [in] | is_show_all_layers | A 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()

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.

## Member Data Documentation

## ◆ e_CompareTypeAll

FSDK.Comparison.e_CompareTypeAll
| static

Enumeration for compare type flags.

Values of this enumeration can be used alone and some values can be used in combination.

Compare all content. This value should be used alone.