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

Public Member Functions

def Preflight ()
 Constructor.
More...
 
def Analyze (preflight_setting_data, progress_callback)
 Analyze a PDF file.
More...
 
def AnalyzeAndFixup (preflight_setting_data, progress_callback)
 Analyze and fixup a PDF file.
More...
 
def CanFixup (item_key)
 Check whether the item key can be fixuped or not.
More...
 
def GenerateReport (preflight_report_setting_data, progress_callback)
 Generate report after analyzing or fixing.
More...
 
def GetGroupNamesArray (library_type, operate_type)
 Get all group names array corresponding to the library type and operation type.
More...
 
def GetItemKeysArray (group_name)
 Get item keys array with the specific group name.
More...
 
def 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()

def FoxitPDFSDKPython2.Preflight.Preflight ( )

Constructor.

Constructor, with another Preflight compliance object.

Parameters
[in]otherAnother Preflight compliance object.

Member Function Documentation

◆ Analyze()

def FoxitPDFSDKPython2.Preflight.Analyze (   preflight_setting_data,
  progress_callback 
)

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

def FoxitPDFSDKPython2.Preflight.AnalyzeAndFixup (   preflight_setting_data,
  progress_callback 
)

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

def FoxitPDFSDKPython2.Preflight.CanFixup (   item_key)

Check whether the item key can be fixuped or not.

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

◆ GenerateReport()

def FoxitPDFSDKPython2.Preflight.GenerateReport (   preflight_report_setting_data,
  progress_callback 
)

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

def FoxitPDFSDKPython2.Preflight.GetGroupNamesArray (   library_type,
  operate_type 
)

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 FoxitPDFSDKPython2.PreflightSettingData.e_LibraryTypeFoxit and this should be one of these values.
[in]operate_typeThe operate type. Please refer to values starting from FoxitPDFSDKPython2.PreflightSettingData.e_OperateTypeProfiles and this should be one of these values.
Returns
The group names array.

◆ GetItemKeysArray()

def FoxitPDFSDKPython2.Preflight.GetItemKeysArray (   group_name)

Get item keys array with the specific group name.

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

◆ IsEmpty()

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