Foxit PDF SDK
fsdk.OptimizeScannedPDFSettings Class Reference

Public Member Functions

def IsEmpty ()
 Check whether current object is empty or not. More...
 
def SetColorGrayImageCompressionMode (mode)
 Set compression mode used for optimizing color/gray images in the scanned PDF document. More...
 
def SetColorGrayImageCompressionQuality (quality)
 Set the quality for lossy compression modes, used for optimizing color/gray images in a scanned PDF document. More...
 
def SetMonoImageCompressionMode (mode)
 Set compression mode used for optimizing monochrome images in a scanned PDF document. More...
 
def SetOptimizedPages (pages)
 Set the pages which will be optimized. More...
 

Detailed Description

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

See also
Optimizer

Member Function Documentation

◆ IsEmpty()

def fsdk.OptimizeScannedPDFSettings.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.

◆ SetColorGrayImageCompressionMode()

def fsdk.OptimizeScannedPDFSettings.SetColorGrayImageCompressionMode (   mode)

Set compression mode used for optimizing color/gray images in the scanned PDF document.

For a newly constructed object, if this function is not called to set option, that means to use OptimizeScannedPDFSettings::e_ImageCompressjpeg as the default value of this option.

Parameters
[in]modeImage compression mode. Please refer to values starting from fsdk.OptimizeScannedPDFSettingsE_ScannedImageCompressHigh and this should be one of these values.
Returns
None.

◆ SetColorGrayImageCompressionQuality()

def fsdk.OptimizeScannedPDFSettings.SetColorGrayImageCompressionQuality (   quality)

Set the quality for lossy compression modes, used for optimizing color/gray images in a scanned PDF document.

For a newly constructed object, if this function is not called to set this option, that means to use 33 as the default value of this option.

Parameters
[in]qualityQuality value for lossy compression modes, the value must between 0 and 100.
Note
This method only valid in fsdk.OptimizeScannedPDFSettingsE_ScannedImageCompressHigh and fsdk.OptimizeScannedPDFSettingsE_ScannedImageCompressjpeg compress mode.
Returns
None.

◆ SetMonoImageCompressionMode()

def fsdk.OptimizeScannedPDFSettings.SetMonoImageCompressionMode (   mode)

Set compression mode used for optimizing monochrome images in a scanned PDF document.

For a newly constructed object, if this function is not called to set option, that means to use fsdk.OptimizeScannedPDFSettingsE_ScannedMonoImageCompressjbig2Lossy as the default value of this option.

Parameters
[in]modeImage compression mode. Please refer to values starting from fsdk.OptimizeScannedPDFSettingsE_ScannedMonoImageCompressjbig2Lossy and this should be one of these values.
Returns
None.

◆ SetOptimizedPages()

def fsdk.OptimizeScannedPDFSettings.SetOptimizedPages (   pages)

Set the pages which will be optimized.

For a newly constructed object,if this function is not called. all pages will be optimized.

Parameters
[in]pagesThe Specify pages, If pages doesn't not add pages index means all pages will be optimized.
Returns
None.