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

Public Member Functions

 Preflight ()
 Constructor.
 
 Preflight (Preflight other)
 Constructor, with another Preflight compliance object. More...
 
void Analyze (PreflightSettingData preflight_setting_data, ProgressCallback progress_callback)
 Analyze a PDF file. More...
 
void AnalyzeAndFixup (PreflightSettingData preflight_setting_data, ProgressCallback progress_callback)
 Analyze and fixup a PDF file. More...
 
bool CanFixup (string item_key)
 Check whether the item key can be fixuped or not. More...
 
bool GenerateReport (PreflightReportSettingData preflight_report_setting_data, ProgressCallback progress_callback)
 Generate report after analyzing or fixing. More...
 
StringArray GetGroupNamesArray (PreflightSettingData.LibraryType library_type, PreflightSettingData.OperateType operate_type)
 Get all group names array corresponding to the library type and operation type. More...
 
StringArray GetItemKeysArray (string group_name)
 Get item keys array with the specific group name. More...
 
bool IsEmpty ()
 Check whether current object is empty or not. More...
 

Detailed Description

This class represents a analyze and fixup funciton matches a specified industry profile, check or fixup.

Constructor & Destructor Documentation

◆ Preflight()

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

Constructor, with another Preflight compliance object.

Parameters
[in]otherAnother Preflight compliance object.

Member Function Documentation

◆ Analyze()

void foxit.addon.compliance.Preflight.Analyze ( PreflightSettingData  preflight_setting_data,
ProgressCallback  progress_callback 
)
inline

Analyze a PDF file.

Parameters
[in]preflight_setting_dataThe preflight setting data.
[in]progress_callbackA ProgressCallback object which is implemented by user and can be used to get progress data.
Returns
None.

◆ AnalyzeAndFixup()

void foxit.addon.compliance.Preflight.AnalyzeAndFixup ( PreflightSettingData  preflight_setting_data,
ProgressCallback  progress_callback 
)
inline

Analyze and fixup a PDF file.

Parameters
[in]preflight_setting_dataThe preflight setting data.
[in]progress_callbackA ProgressCallback object which is implemented by user and can be used to get progress data.
Returns
None.

◆ CanFixup()

bool foxit.addon.compliance.Preflight.CanFixup ( string  item_key)
inline

Check whether the item key can be fixuped or not.

Parameters
[in]item_keyThe item key. It can be retrieved by Preflight.GetItemKeysArray .
Returns
true means can be fixuped, while false means can not be fixuped.

◆ GenerateReport()

bool foxit.addon.compliance.Preflight.GenerateReport ( PreflightReportSettingData  preflight_report_setting_data,
ProgressCallback  progress_callback 
)
inline

Generate report after analyzing or fixing.

Parameters
[in]preflight_report_setting_dataThe preflight report setting data.
[in]progress_callbackA ProgressCallback object which is implemented by user and can be used to get progress data.
Returns
true means success, while false means failure.

◆ GetGroupNamesArray()

StringArray foxit.addon.compliance.Preflight.GetGroupNamesArray ( PreflightSettingData.LibraryType  library_type,
PreflightSettingData.OperateType  operate_type 
)
inline

Get all group names array corresponding to the library type and operation type.

Parameters
[in]library_typeThe library type.

Please refer to values starting from foxit.addon.compliance.PreflightSettingData.LibraryType.e_LibraryTypeFoxit and this should be one of these values.

Parameters
[in]operate_typeThe operate type. Please refer to values starting from foxit.addon.compliance.PreflightSettingData.OperateType.e_OperateTypeProfiles and this should be one of these values.
Returns
The group names array.

◆ GetItemKeysArray()

StringArray foxit.addon.compliance.Preflight.GetItemKeysArray ( string  group_name)
inline

Get item keys array with the specific group name.

Parameters
[in]group_nameThe group name which can obtain from the Preflight.GetGroupNamesArray interface.
Returns
The item keys array.

◆ IsEmpty()

bool foxit.addon.compliance.Preflight.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.