Foxit PDF SDK
foxit.addon.compliance.PDFECompliance Class Reference
Inheritance diagram for foxit.addon.compliance.PDFECompliance:
foxit.common.Base

Public Types

enum  Version { Version.e_VersionPDFE1 = 1 }
 Enumeration for PDF/E version. More...
 

Public Member Functions

 PDFECompliance ()
 Constructor.
 
 PDFECompliance (PDFECompliance other)
 Constructor, with another PDFE compliance object. More...
 
ResultInformation ConvertPDFFile (string src_pdf_path, string saved_pdf_path, PDFECompliance.Version convert_to_version, ProgressCallback progress_callback)
 Convert a PDF file with specified PDFE version. More...
 
bool IsEmpty ()
 Check whether current object is empty or not. More...
 
ResultInformation Verify (string src_pdf_path, int first_page_index, int last_page_index, PDFECompliance.Version verify_version, ProgressCallback progress_callback)
 Verify a PDF file with specified PDFE version. More...
 

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

Member Enumeration Documentation

◆ Version

Enumeration for PDF/E version.

Values of this enumeration should be used alone.

Enumerator
e_VersionPDFE1 

PDF/E-1.

Constructor & Destructor Documentation

◆ PDFECompliance()

foxit.addon.compliance.PDFECompliance.PDFECompliance ( PDFECompliance  other)
inline

Constructor, with another PDFE compliance object.

Parameters
[in]otherAnother PDFE compliance object.

Member Function Documentation

◆ ConvertPDFFile()

ResultInformation foxit.addon.compliance.PDFECompliance.ConvertPDFFile ( string  src_pdf_path,
string  saved_pdf_path,
PDFECompliance.Version  convert_to_version,
ProgressCallback  progress_callback 
)
inline

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 foxit.addon.compliance.PDFECompliance.Version.e_VersionPDFE1 and this should be one of these values. Default value: foxit.addon.compliance.PDFECompliance.Version.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()

bool foxit.addon.compliance.PDFECompliance.IsEmpty ( )
inline

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()

ResultInformation foxit.addon.compliance.PDFECompliance.Verify ( string  src_pdf_path,
int  first_page_index,
int  last_page_index,
PDFECompliance.Version  verify_version,
ProgressCallback  progress_callback 
)
inline

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.