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

Public Member Functions

def OptimizerSettings ()
 Constructor. More...
 
def IsEmpty ()
 Check whether current object is empty or not. More...
 
def SetCleanUpOptions (clean_up_options)
 Set optimization related options for cleaning up. More...
 
def SetColorGrayImageSettings (settings)
 Set optimization related settings for color/gray image. More...
 
def SetDiscardObjectsOptions (discard_objects_options)
 Set optimization related options for discarding objects. More...
 
def SetDiscardUserDataOptions (discard_userdata_options)
 Set optimization related options for discarding user data. More...
 
def SetMonoImageSettings (settings)
 Set optimization related settings for monochrome image. More...
 
def SetOptimizerOptions (optimize_options)
 Set options to decide which kind of optimizer setting will be used for optimizing PDF document. More...
 
def SetUnembeddedFontSettings (settings)
 Set optimization related settings for unembedding fonts. More...
 

Static Public Attributes

 e_CleanUpRemoveInvalidBookmarks = _fsdk.OptimizerSettings_e_CleanUpRemoveInvalidBookmarks
 Remove invalid bookmarks.
 
 e_CleanUpRemoveInvalidLinks = _fsdk.OptimizerSettings_e_CleanUpRemoveInvalidLinks
 Remove invalid links.
 
 e_CleanUpUseFlateForNonEncodedStream = _fsdk.OptimizerSettings_e_CleanUpUseFlateForNonEncodedStream
 Use Flate to encode streams that are not encoded.
 
 e_CleanUpUseFlateInsteadOfLZW = _fsdk.OptimizerSettings_e_CleanUpUseFlateInsteadOfLZW
 In streams that use LZW encoding, use Flate instead.
 
 e_DiscardObjectsAlternateImages = _fsdk.OptimizerSettings_e_DiscardObjectsAlternateImages
 Discard all alternate images. More...
 
 e_DiscardObjectsBookmarks = _fsdk.OptimizerSettings_e_DiscardObjectsBookmarks
 Discard bookmarks.
 
 e_DiscardObjectsDocumentTags = _fsdk.OptimizerSettings_e_DiscardObjectsDocumentTags
 Discard document tags.
 
 e_DiscardObjectsEmbeddedPageThumbnails = _fsdk.OptimizerSettings_e_DiscardObjectsEmbeddedPageThumbnails
 Discard embedded page thumbnails.
 
 e_DiscardObjectsEmbeddedPrintSettings = _fsdk.OptimizerSettings_e_DiscardObjectsEmbeddedPrintSettings
 Discard embedded print settings.
 
 e_DiscardObjectsEmbeddedSearchIndex = _fsdk.OptimizerSettings_e_DiscardObjectsEmbeddedSearchIndex
 Discard embedded search index.
 
 e_DiscardObjectsFlattenFormFields = _fsdk.OptimizerSettings_e_DiscardObjectsFlattenFormFields
 Flatten form fields.
 
 e_DiscardObjectsFormActions = _fsdk.OptimizerSettings_e_DiscardObjectsFormActions
 Discard all form submission, import and reset actions.
 
 e_DiscardObjectsJavaScriptActions = _fsdk.OptimizerSettings_e_DiscardObjectsJavaScriptActions
 Discard all JavaScript actions. More...
 
 e_DiscardUserDataAllAnnotsFormsAndMultimedia = _fsdk.OptimizerSettings_e_DiscardUserDataAllAnnotsFormsAndMultimedia
 Discard all annotations, forms and multimedia.
 
 e_DiscardUserDataDocumentInfoAndMetaData = _fsdk.OptimizerSettings_e_DiscardUserDataDocumentInfoAndMetaData
 Discard document information and metadata.
 
 e_DiscardUserDataExternalCrossReferences = _fsdk.OptimizerSettings_e_DiscardUserDataExternalCrossReferences
 Discard external cross references.
 
 e_DiscardUserDataFileAttchments = _fsdk.OptimizerSettings_e_DiscardUserDataFileAttchments
 Discard file attachments.
 
 e_DiscardUserDataLayer = _fsdk.OptimizerSettings_e_DiscardUserDataLayer
 Discard hidden layer content and flatten visible layers.
 
 e_DiscardUserDataPrivateDataOfOtherApp = _fsdk.OptimizerSettings_e_DiscardUserDataPrivateDataOfOtherApp
 Discard private data of other applications.
 
 e_OptimizerCleanUp = _fsdk.OptimizerSettings_e_OptimizerCleanUp
 Optimize PDF document by cleaning up.
 
 e_OptimizerCompressImages = _fsdk.OptimizerSettings_e_OptimizerCompressImages
 Optimize PDF document by compressing images.
 
 e_OptimizerDiscardObjects = _fsdk.OptimizerSettings_e_OptimizerDiscardObjects
 Optimize PDF document by discarding objects.
 
 e_OptimizerDiscardUserData = _fsdk.OptimizerSettings_e_OptimizerDiscardUserData
 Optimize PDF document by discarding user data.
 
 e_OptimizerUnembeddedFonts = _fsdk.OptimizerSettings_e_OptimizerUnembeddedFonts
 Optimize PDF document by unembedding some embedded fonts.
 

Detailed Description

This class represents settings for optimizing a PDF document. It would be used in class Optimizer .

See also
Optimizer

Constructor & Destructor Documentation

◆ OptimizerSettings()

def FoxitPDFSDKPython2.OptimizerSettings.OptimizerSettings ( )

Constructor.

Constructor, with another optimizer settings object.

This constructor is to construct a optimizer settings object with default setting options. User can also call "set" methods in this class to change setting options. Please refer to comment in other settings class (which can be set to current object) for more details about what default setting options are.

Parameters
[in]otherAnother optimizer settings object.

Member Function Documentation

◆ IsEmpty()

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

◆ SetCleanUpOptions()

def FoxitPDFSDKPython2.OptimizerSettings.SetCleanUpOptions (   clean_up_options)

Set optimization related options for cleaning up.

For a newly constructed object, if this function is not called to set any clean-up options, that means not to do clean- up optimization. Clean-up options set by this function are useful only when option value FoxitPDFSDKPython2.OptimizerSettings.e_OptimizerCleanUp is set by function FoxitPDFSDKPython2.OptimizerSettings.SetOptimizerOptions .

Parameters
[in]clean_up_optionsOptimization related options for cleaning up. 0 means not to do clean-up optimization. Please refer to values starting from FoxitPDFSDKPython2.OptimizerSettings.e_CleanUpUseFlateForNonEncodedStream and this can be one or a combination of these values.
Returns
None.

◆ SetColorGrayImageSettings()

def FoxitPDFSDKPython2.OptimizerSettings.SetColorGrayImageSettings (   settings)

Set optimization related settings for color/gray image.

For a newly constructed object, if this function is not called to set any color/gray image settings, that means to use default color/gray image settings. Please refer to comment in class ImageSettings for default values.
ImageSettings set by this function is useful only when option value FoxitPDFSDKPython2.OptimizerSettings.e_OptimizerCompressImages is set by function FoxitPDFSDKPython2.OptimizerSettings.SetOptimizerOptions .

Parameters
[in]settingsOptimization related settings for color and grayscale images.
Returns
None.

◆ SetDiscardObjectsOptions()

def FoxitPDFSDKPython2.OptimizerSettings.SetDiscardObjectsOptions (   discard_objects_options)

Set optimization related options for discarding objects.

For a newly constructed object, if this function is not called to set any discard-objects options, that means not to do discard-objects optimization. Discard-objects options set by this function are useful only when option value FoxitPDFSDKPython2.OptimizerSettings.e_OptimizerDiscardObjects is set by function FoxitPDFSDKPython2.OptimizerSettings.SetOptimizerOptions .

Parameters
[in]discard_objects_optionsOptimization related options for discarding objects. 0 means not to do discarding-objects optimization. Please refer to values starting from FoxitPDFSDKPython2.OptimizerSettings.e_DiscardObjectsFormActions and this can be one or a combination of these values.
Returns
None.

◆ SetDiscardUserDataOptions()

def FoxitPDFSDKPython2.OptimizerSettings.SetDiscardUserDataOptions (   discard_userdata_options)

Set optimization related options for discarding user data.

For a newly constructed object, if this function is not called to set any discard-userdata options, that means not to do discard-userdata optimization. Discard-userdata options set by this function are useful only when option value FoxitPDFSDKPython2.OptimizerSettings.e_OptimizerDiscardUserData is set by function FoxitPDFSDKPython2.OptimizerSettings.SetOptimizerOptions .

Parameters
[in]discard_userdata_optionsOptimization related options for discarding user data. 0 means not to do discarding-userdata optimization. Please refer to values starting from FoxitPDFSDKPython2.OptimizerSettings.e_DiscardUserDataAllAnnotsFormsAndMultimedia and this can be one or a combination of these values.
Returns
None.

◆ SetMonoImageSettings()

def FoxitPDFSDKPython2.OptimizerSettings.SetMonoImageSettings (   settings)

Set optimization related settings for monochrome image.

For a newly constructed object, if this function is not called to set any monochrome image settings, that means to use default monochrome image settings. Please refer to comment in class MonoImageSettings for detail values.
MonoImageSettings set by this function is useful only when option value FoxitPDFSDKPython2.OptimizerSettings.e_OptimizerCompressImages is set by function FoxitPDFSDKPython2.OptimizerSettings.SetOptimizerOptions .

Parameters
[in]settingsOptimization related settings for monochrome images.
Returns
None.

◆ SetOptimizerOptions()

def FoxitPDFSDKPython2.OptimizerSettings.SetOptimizerOptions (   optimize_options)

Set options to decide which kind of optimizer setting will be used for optimizing PDF document.

For a newly constructed object, if this function is not called to set any optimizer options, that means no optimizer setting is useful.

Parameters
[in]optimize_optionsThe options to decide which kind of optimizer setting will be used for optimizing PDF document. 0 means no optimizer setting of any kind is useful. Please refer to values starting from FoxitPDFSDKPython2.OptimizerSettings.e_OptimizerCompressImages and this can be one or a combination of these values.
Returns
None.

◆ SetUnembeddedFontSettings()

def FoxitPDFSDKPython2.OptimizerSettings.SetUnembeddedFontSettings (   settings)

Set optimization related settings for unembedding fonts.

For a newly constructed object, if this function is not called to set any unembedded fonts settings, that means to no font is to be unembedded. UnembeddedFontSettings set by this function is useful only when option value FoxitPDFSDKPython2.OptimizerSettings.e_OptimizerUnembeddedFonts is set by function FoxitPDFSDKPython2.OptimizerSettings.SetOptimizerOptions .

Parameters
[in]settingsOptimization related settings for unembedding fonts.
Returns
None.

Member Data Documentation

◆ e_DiscardObjectsAlternateImages

FoxitPDFSDKPython2.OptimizerSettings.e_DiscardObjectsAlternateImages = _fsdk.OptimizerSettings_e_DiscardObjectsAlternateImages
static

Discard all alternate images.

Some PDF documents include multiple versions of the same image for different purposes, such as low-resolution on-screen viewing and high-resolution printing. If this option value is set to be used, that means to remove all versions of an image except the one destined for on-screen viewing.

◆ e_DiscardObjectsJavaScriptActions

FoxitPDFSDKPython2.OptimizerSettings.e_DiscardObjectsJavaScriptActions = _fsdk.OptimizerSettings_e_DiscardObjectsJavaScriptActions
static

Discard all JavaScript actions.

Currently, it can not remove the javascript action in "OpenAction" of catalog.