Foxit PDF SDK
|
Public Member Functions | |
OptimizerSettings () | |
Constructor. More... | |
OptimizerSettings (OptimizerSettings other) | |
Constructor, with another result information object. More... | |
bool | IsEmpty () |
Check whether current object is empty or not. More... | |
void | SetCleanUpOptions (int clean_up_options) |
Set optimization related options for cleaning up. More... | |
void | SetColorGrayImageSettings (ImageSettings settings) |
Set optimization related settings for color/gray image. More... | |
void | SetDiscardObjectsOptions (int discard_objects_options) |
Set optimization related options for discarding objects. More... | |
void | SetDiscardUserDataOptions (int discard_userdata_options) |
Set optimization related options for discarding user data. More... | |
void | SetMonoImageSettings (MonoImageSettings settings) |
Set optimization related settings for monochrome image. More... | |
void | SetOptimizerOptions (int optimize_options) |
Set options to decide which kind of optimizer setting will be used for optimizing PDF document. More... | |
void | SetUnembeddedFontSettings (UnembeddedFontSettings settings) |
Set optimization related settings for unembedding fonts. More... | |
This class represents settings for optimizing a PDF document. It would be used in class Optimizer .
Enumeration for cleaning up options.
Values of this enumeration can be used alone or in a combination.
Enumeration for discarding objects options.
Values of this enumeration can be used alone or in a combination.
Enumeration for discarding user data options.
Values of this enumeration can be used alone or in a combination.
Enumeration for optimizer options.
Values of this enumeration can be used alone or in a combination.
|
inline |
Constructor.
This constructor is to construct a optimizer settings object with default setting options. User can also calling "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.
|
inline |
Constructor, with another result information object.
[in] | other | Another optimizer settings object. |
|
inline |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
|
inline |
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 foxit.addon.optimization.OptimizerSettings.OptimizerOptions.e_OptimizerCleanUp is set by function OptimizerSettings.SetOptimizerOptions .
[in] | clean_up_options | Optimization related options for cleaning up. 0 means not to do clean-up optimization. Please refer to values starting from foxit.addon.optimization.OptimizerSettings.CleanUpOptions.e_CleanUpUseFlateForNonEncodedStream and this can be one or a combination of these values. |
|
inline |
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 foxit.addon.optimization.OptimizerSettings.OptimizerOptions.e_OptimizerCompressImages is set by function OptimizerSettings.SetOptimizerOptions .
[in] | settings | Optimization related settings for color and grayscale images. |
|
inline |
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 foxit.addon.optimization.OptimizerSettings.OptimizerOptions.e_OptimizerDiscardObjects is set by function OptimizerSettings.SetOptimizerOptions .
[in] | discard_objects_options | Optimization related options for discarding objects. 0 means not to do discarding-objects optimization. Please refer to values starting from foxit.addon.optimization.OptimizerSettings.DiscardObjectsOptions.e_DiscardObjectsFormActions and this can be one or a combination of these values. |
|
inline |
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 foxit.addon.optimization.OptimizerSettings.OptimizerOptions.e_OptimizerDiscardUserData is set by function OptimizerSettings.SetOptimizerOptions .
[in] | discard_userdata_options | Optimization related options for discarding user data. 0 means not to do discarding-userdata optimization. Please refer to values starting from foxit.addon.optimization.OptimizerSettings.DiscardUserDataOptions.e_DiscardUserDataAllAnnotsFormsAndMultimedia and this can be one or a combination of these values. |
|
inline |
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 foxit.addon.optimization.OptimizerSettings.OptimizerOptions.e_OptimizerCompressImages is set by function OptimizerSettings.SetOptimizerOptions .
[in] | settings | Optimization related settings for monochrome images. |
|
inline |
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.
[in] | optimize_options | The 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 foxit.addon.optimization.OptimizerSettings.OptimizerOptions.e_OptimizerCompressImages and this can be one or a combination of these values. |
|
inline |
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 foxit.addon.optimization.OptimizerSettings.OptimizerOptions.e_OptimizerUnembeddedFonts is set by function OptimizerSettings.SetOptimizerOptions .
[in] | settings | Optimization related settings for unembedding fonts. |