Foxit PDF SDK
FoxitPDFSDKPython2.PDFECompliance Class Reference
Inheritance diagram for FoxitPDFSDKPython2.PDFECompliance:
FoxitPDFSDKPython2.Base

Public Member Functions

def PDFECompliance ()
 Constructor. More...
 
def ConvertPDFFile (src_pdf_path, saved_pdf_path, convert_to_version, progress_callback)
 Convert a PDF file with specified PDFE version. More...
 
def IsEmpty ()
 Check whether current object is empty or not. More...
 
def Verify (src_pdf_path, first_page_index, last_page_index, verify_version, progress_callback)
 Verify a PDF file with specified PDFE version. More...
 

Static Public Attributes

 e_VersionPDFE1 = _fsdk.PDFECompliance_e_VersionPDFE1
 PDF/E-1.
 

Detailed Description

This class can be used to verify if a PDF file matches a PDF/E version or convert a PDF file to a PDF/E version. Please ensure ComplianceEngine has been initialized successfully.

See also
ComplianceEngine

Constructor & Destructor Documentation

◆ PDFECompliance()

def FoxitPDFSDKPython2.PDFECompliance.PDFECompliance ( )

Constructor.

Constructor, with another PDFE compliance object.

Parameters
[in]otherAnother PDFE compliance object.

Member Function Documentation

◆ ConvertPDFFile()

def FoxitPDFSDKPython2.PDFECompliance.ConvertPDFFile (   src_pdf_path,
  saved_pdf_path,
  convert_to_version,
  progress_callback 
)

Convert a PDF file with specified PDFE version.

Parameters
[in]src_pdf_pathA complete path of source PDF file to be converted. This should not be an empty string.
[in]saved_pdf_pathA complete path for saving the converted PDF file. This should not be an empty string.
[in]convert_to_versionPDFE version to convert. Please refer to values starting from FoxitPDFSDKPython2.PDFECompliance.e_VersionPDFE1 and this should be one of these values. Default value: FoxitPDFSDKPython2.PDFECompliance.e_VersionPDFE1 .
[in]progress_callbackProgress callback which is implemented by user and can be used to get progress data. This can be null. Default value: null.
Returns
A ResultInformation object.

◆ IsEmpty()

def FoxitPDFSDKPython2.PDFECompliance.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.

◆ Verify()

def FoxitPDFSDKPython2.PDFECompliance.Verify (   src_pdf_path,
  first_page_index,
  last_page_index,
  verify_version,
  progress_callback 
)

Verify a PDF file with specified PDFE version.

Parameters
[in]src_pdf_pathA complete path of source PDF file to be verified. This should not be an empty string.
[in]first_page_indexIndex of the first page to be verified, staring from 0. Default value: 0.
[in]last_page_indexIndex of the last page to be verified. If this is -1, that means all the pages of the source PDF file will be verified and parameter first_page_index would be ignored. Default value: -1.
[in]verify_versionPDFE version to verify.
[in]progress_callbackProgress callback which is implemented by user and can be used to get progress data. This can be null. Default value: null.
Returns
A ResultInformation object.