Foxit PDF SDK
fsdk.OptimizerSettings Class Reference

Public Member Functions

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)
 
def SetColorImageSettings (settings)
 Set optimization related settings for color 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 SetGrayscaleImageSettings (settings)
 Set optimization related settings for grayscale image. 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...
 

Detailed Description

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

See also
Optimizer

Member Function Documentation

◆ IsEmpty()

def fsdk.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 fsdk.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 fsdk.OptimizerSettingsE_OptimizerCleanUp is set by function fsdk.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 fsdk.OptimizerSettingsE_CleanUpUseFlateForNonEncodedStream and this can be one or a combination of these values.
Returns
None.

◆ SetColorGrayImageSettings()

def fsdk.OptimizerSettings.SetColorGrayImageSettings (   settings)
Deprecated:
Current function has been deprecated since Foxit PDF SDK 10.0. This function will not have any effect on OptimizerSettings any more. For setting color image, please call function fsdk.OptimizerSettings.SetColorImageSettings . Please refer to SetColorImageSettings related function in OptimizerSettings for more details. For setting grayscale image, please call function fsdk.OptimizerSettings.SetGrayscaleImageSettings . Please refer to SetGrayscaleImageSettings related function in OptimizerSettings for more details.

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 fsdk.OptimizerSettingsE_OptimizerCompressImages is set by function fsdk.OptimizerSettings.SetOptimizerOptions .

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

◆ SetColorImageSettings()

def fsdk.OptimizerSettings.SetColorImageSettings (   settings)

Set optimization related settings for color image.

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

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

◆ SetDiscardObjectsOptions()

def fsdk.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 fsdk.OptimizerSettingsE_OptimizerDiscardObjects is set by function fsdk.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 fsdk.OptimizerSettingsE_DiscardObjectsFormActions and this can be one or a combination of these values.
Returns
None.

◆ SetDiscardUserDataOptions()

def fsdk.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 fsdk.OptimizerSettingsE_OptimizerDiscardUserData is set by function fsdk.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 fsdk.OptimizerSettingsE_DiscardUserDataAllAnnotsFormsAndMultimedia and this can be one or a combination of these values.
Returns
None.

◆ SetGrayscaleImageSettings()

def fsdk.OptimizerSettings.SetGrayscaleImageSettings (   settings)

Set optimization related settings for grayscale image.

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

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

◆ SetMonoImageSettings()

def fsdk.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 fsdk.OptimizerSettingsE_OptimizerCompressImages is set by function fsdk.OptimizerSettings.SetOptimizerOptions .

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

◆ SetOptimizerOptions()

def fsdk.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 fsdk.OptimizerSettingsE_OptimizerCompressImages and this can be one or a combination of these values.
Returns
None.

◆ SetUnembeddedFontSettings()

def fsdk.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 fsdk.OptimizerSettingsE_OptimizerUnembeddedFonts is set by function fsdk.OptimizerSettings.SetOptimizerOptions .

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