Foxit PDF SDK
FSPDFACompliance Class Reference
Inheritance diagram for FSPDFACompliance:
FSBase

Instance Methods

(FSResultInformation *) - convertPDFFile:saved_pdf_path:convert_to_version:progress_callback:
 Convert a PDF file with specified PDFA version.
More...
 
(id) - init
 Constructor.

 
(id) - initWithOther:
 Constructor, with another PDFA compliance object.
More...
 
(BOOL) - isEmpty
 Check whether current object is empty or not.
More...
 
(FSResultInformation *) - verify:src_pdf_path:first_page_index:last_page_index:progress_callback:
 Verify a PDF file with specified PDFA version.
More...
 

Detailed Description

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

See also
FSComplianceEngine

Method Documentation

◆ convertPDFFile:saved_pdf_path:convert_to_version:progress_callback:()

- (FSResultInformation *) convertPDFFile: (NSString *)  src_pdf_path
saved_pdf_path: (NSString *)  saved_pdf_path
convert_to_version: (FSPDFAComplianceVersion convert_to_version
progress_callback: (id<FSComplianceProgressCallback>)  progress_callback 

Convert a PDF file with specified PDFA 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_versionPDFA version to convert to.Please refer to values starting from FSPDFAComplianceVersionPDFA1a and this should be one of these values.
[in]progress_callbackProgress callback which is implemented by user and can be used to get progress data. This can be nil.
Returns
A FSResultInformation object.

◆ initWithOther:()

- (id) initWithOther: (FSPDFACompliance*)  other

Constructor, with another PDFA compliance object.

Parameters
[in]otherAnother PDFA compliance object.

◆ isEmpty()

- (BOOL) isEmpty

Check whether current object is empty or not.

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

Returns
YES means current object is empty, while NO means not.

◆ verify:src_pdf_path:first_page_index:last_page_index:progress_callback:()

- (FSResultInformation *) verify: (FSPDFAComplianceVersion verify_version
src_pdf_path: (NSString *)  src_pdf_path
first_page_index: (int)  first_page_index
last_page_index: (int)  last_page_index
progress_callback: (id<FSComplianceProgressCallback>)  progress_callback 

Verify a PDF file with specified PDFA version.

Parameters
[in]verify_versionPDFA version to verify.
[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.
[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.
[in]progress_callbackProgress callback which is implemented by user and can be used to get progress data. This can be nil.
Returns
A FSResultInformation object.