Foxit PDF SDK
Public 类型 | Public 成员函数 | 所有成员列表
foxit.addon.optimization.OptimizerSettings类 参考
类 foxit.addon.optimization.OptimizerSettings 继承关系图:
foxit.common.Base

Public 类型

enum  CleanUpOptions {
  CleanUpOptions.e_CleanUpUseFlateForNonEncodedStream = 0x01, CleanUpOptions.e_CleanUpUseFlateInsteadOfLZW = 0x02, CleanUpOptions.e_CleanUpRemoveInvalidBookmarks = 0x04, CleanUpOptions.e_CleanUpRemoveInvalidLinks = 0x08,
  CleanUpOptions.e_CleanUpDiscardUnreferencedNamedDes = 0x10, CleanUpOptions.e_CleanUpOptPageContent = 0x20
}
 清理选项的枚举。 更多...
 
enum  DiscardObjectsOptions {
  DiscardObjectsOptions.e_DiscardObjectsFormActions = 0x01, DiscardObjectsOptions.e_DiscardObjectsFlattenFormFields = 0x02, DiscardObjectsOptions.e_DiscardObjectsJavaScriptActions = 0x04, DiscardObjectsOptions.e_DiscardObjectsEmbeddedPageThumbnails = 0x08,
  DiscardObjectsOptions.e_DiscardObjectsEmbeddedPrintSettings = 0x10, DiscardObjectsOptions.e_DiscardObjectsBookmarks = 0x20, DiscardObjectsOptions.e_DiscardObjectsAlternateImages = 0x40, DiscardObjectsOptions.e_DiscardObjectsDocumentTags = 0x80,
  DiscardObjectsOptions.e_DiscardObjectsEmbeddedSearchIndex = 0x100, DiscardObjectsOptions.e_DiscardObjectsDetectAndMergeImageFragment = 0x200, DiscardObjectsOptions.e_DiscardObjectsSmoothlinestocurves = 0x400
}
 丢弃对象选项的枚举。 更多...
 
enum  DiscardUserDataOptions {
  DiscardUserDataOptions.e_DiscardUserDataAllAnnotsFormsAndMultimedia = 0x01, DiscardUserDataOptions.e_DiscardUserDataExternalCrossReferences = 0x02, DiscardUserDataOptions.e_DiscardUserDataDocumentInfoAndMetaData = 0x04, DiscardUserDataOptions.e_DiscardUserDataFileAttchments = 0x08,
  DiscardUserDataOptions.e_DiscardUserDataPrivateDataOfOtherApp = 0x10, DiscardUserDataOptions.e_DiscardUserDataLayer = 0x20, DiscardUserDataOptions.e_DiscardUserAllData = 0x40
}
 丢弃用户数据选项的枚举。 更多...
 
enum  OptimizerOptions {
  OptimizerOptions.e_OptimizerCompressImages = 0x01, OptimizerOptions.e_OptimizerCleanUp = 0x02, OptimizerOptions.e_OptimizerDiscardObjects = 0x04, OptimizerOptions.e_OptimizerUnembeddedFonts = 0x08,
  OptimizerOptions.e_OptimizerDiscardUserData = 0x10
}
 优化器选项的枚举。 更多...
 
enum  TransparencyMode { TransparencyMode.e_TransparencyModeLowResolution = 0, TransparencyMode.e_TransparencyModeMediumResolution = 1, TransparencyMode.e_TransparencyModeHighResolution = 2 }
 透明度模式的枚举。 更多...
 

Public 成员函数

 OptimizerSettings ()
 构造函数。 更多...
 
 OptimizerSettings (OptimizerSettings other)
 构造函数，使用另一个优化器设置对象。 更多...
 
bool IsEmpty ()
 检查当前对象是否为空。 更多...
 
void SetCleanUpOptions (int clean_up_options)
 设置清理的优化相关选项。 更多...
 
void SetColorGrayImageSettings (ImageSettings settings)
 
void SetColorImageSettings (ImageSettings settings)
 设置彩色图像的优化相关设置。 更多...
 
void SetDiscardObjectsOptions (int discard_objects_options)
 设置丢弃对象的优化相关选项。 更多...
 
void SetDiscardUserDataOptions (int discard_userdata_options)
 设置丢弃用户数据的优化相关选项。 更多...
 
void SetGrayscaleImageSettings (ImageSettings settings)
 设置灰度图像的优化相关设置。 更多...
 
void SetMonoImageSettings (MonoImageSettings settings)
 设置单色图像的优化相关设置。 更多...
 
void SetOptimizerOptions (int optimize_options)
 设置选项以决定用于优化PDF文档的优化器设置类型。 更多...
 
void SetTransparencyMode (OptimizerSettings.TransparencyMode transparency_mode)
 设置优化透明度模式。 更多...
 
void SetUnembeddedFontSettings (UnembeddedFontSettings settings)
 设置取消嵌入字体的优化相关设置。 更多...
 

详细描述

此类表示优化PDF文档的设置。它将在类 Optimizer 中使用。

参见
Optimizer

成员枚举类型说明

◆ CleanUpOptions

enum foxit.addon.optimization.OptimizerSettings.CleanUpOptions
strong

清理选项的枚举。

此枚举的值可以单独使用或组合使用。

枚举值
e_CleanUpUseFlateForNonEncodedStream 

使用Flate编码未编码的流。

e_CleanUpUseFlateInsteadOfLZW 

在使用LZW编码的流中，改用Flate。

e_CleanUpRemoveInvalidBookmarks 

删除无效的书签。

e_CleanUpRemoveInvalidLinks 

删除无效的链接。

e_CleanUpDiscardUnreferencedNamedDes 

丢弃未引用的命名目标。

e_CleanUpOptPageContent 

清理页面内容，将内容流中的0A、0D更改为空格。

◆ DiscardObjectsOptions

enum foxit.addon.optimization.OptimizerSettings.DiscardObjectsOptions
strong

丢弃对象选项的枚举。

此枚举的值可以单独使用或组合使用。

枚举值
e_DiscardObjectsFormActions 

丢弃所有表单提交、导入和重置操作。

e_DiscardObjectsFlattenFormFields 

扁平化表单字段。

e_DiscardObjectsJavaScriptActions 

丢弃所有JavaScript操作。

目前，它无法删除目录"OpenAction"中的JavaScript操作。

e_DiscardObjectsEmbeddedPageThumbnails 

丢弃嵌入的页面缩略图。

e_DiscardObjectsEmbeddedPrintSettings 

丢弃嵌入的打印设置。

e_DiscardObjectsBookmarks 

丢弃书签。

e_DiscardObjectsAlternateImages 

丢弃所有替代图像。

某些PDF文档包含同一图像的多个版本，用于不同目的， 例如低分辨率屏幕查看和高分辨率打印。 如果设置使用此选项值，表示删除图像的所有版本， 除了用于屏幕查看的版本。

e_DiscardObjectsDocumentTags 

丢弃文档标签。

e_DiscardObjectsEmbeddedSearchIndex 

丢弃嵌入的搜索索引。

e_DiscardObjectsDetectAndMergeImageFragment 

检测并合并图像片段。

e_DiscardObjectsSmoothlinestocurves 

将直线平滑为曲线。

◆ DiscardUserDataOptions

enum foxit.addon.optimization.OptimizerSettings.DiscardUserDataOptions
strong

丢弃用户数据选项的枚举。

此枚举的值可以单独使用或组合使用。

枚举值
e_DiscardUserDataAllAnnotsFormsAndMultimedia 

丢弃所有注释、表单和多媒体。

e_DiscardUserDataExternalCrossReferences 

丢弃外部交叉引用。

e_DiscardUserDataDocumentInfoAndMetaData 

丢弃文档信息和元数据。

e_DiscardUserDataFileAttchments 

丢弃文件附件。

e_DiscardUserDataPrivateDataOfOtherApp 

丢弃其他应用程序的私有数据。

e_DiscardUserDataLayer 

丢弃隐藏图层内容并扁平化可见图层。

e_DiscardUserAllData 

丢弃标签用户数据。

◆ OptimizerOptions

enum foxit.addon.optimization.OptimizerSettings.OptimizerOptions
strong

优化器选项的枚举。

此枚举的值可以单独使用或组合使用。

枚举值
e_OptimizerCompressImages 

通过压缩图像来优化PDF文档。

e_OptimizerCleanUp 

通过清理来优化PDF文档。

e_OptimizerDiscardObjects 

通过丢弃对象来优化PDF文档。

e_OptimizerUnembeddedFonts 

通过取消嵌入某些嵌入字体来优化PDF文档。

e_OptimizerDiscardUserData 

通过丢弃用户数据来优化PDF文档。

◆ TransparencyMode

enum foxit.addon.optimization.OptimizerSettings.TransparencyMode
strong

透明度模式的枚举。

此枚举的值应单独使用。

枚举值
e_TransparencyModeLowResolution 

透明度模式: 低分辨率。

低分辨率包括: 透明度等级: 75; 线条艺术和文字: 288; 渐变和网格: 144; 将所有文本转换为大纲: 不执行; 将所有笔划转换为大纲: 执行; 裁剪复杂区域: 错误; 保留套印: 成功。

e_TransparencyModeMediumResolution 

透明度模式: 中分辨率。

中分辨率包括: 透明度等级: 75; 线条艺术和文字: 300; 渐变和网格: 150; 将所有文本转换为大纲: 不执行; 将所有笔划转换为大纲: 执行; 裁剪复杂区域: 成功; 保留套印: 成功。

e_TransparencyModeHighResolution 

透明度模式: 高分辨率。

高分辨率包括: 透明度等级: 100; 线条艺术和文字: 1200; 渐变和网格: 300; 将所有文本转换为大纲: 不执行; 将所有笔划转换为大纲: 错误; 裁剪复杂区域: 成功; 保留套印: 成功。

构造及析构函数说明

◆ OptimizerSettings() [1/2]

foxit.addon.optimization.OptimizerSettings.OptimizerSettings ( )
inline

构造函数。

此构造函数用于构造具有默认设置选项的优化器设置对象。 用户也可以调用此类中的"set"方法来更改设置选项。 有关默认设置选项的更多详细信息，请参考其他设置类（可以设置到当前对象的）中的注释。

◆ OptimizerSettings() [2/2]

foxit.addon.optimization.OptimizerSettings.OptimizerSettings ( OptimizerSettings  other)
inline

构造函数，使用另一个优化器设置对象。

参数
[in]other另一个优化器设置对象。

成员函数说明

◆ IsEmpty()

bool foxit.addon.optimization.OptimizerSettings.IsEmpty ( )
inline

检查当前对象是否为空。

当当前对象为空时，意味着当前对象无用。

返回
true 表示当前对象为空，false 表示不为空。

◆ SetCleanUpOptions()

void foxit.addon.optimization.OptimizerSettings.SetCleanUpOptions ( int  clean_up_options)
inline

设置清理的优化相关选项。

对于新构造的对象，如果不调用此函数来设置任何清理选项， 那么意味着不进行清理优化。 此函数设置的清理选项仅在选项值 foxit.addon.optimization.OptimizerSettings.OptimizerOptions.e_OptimizerCleanUp 被 函数 OptimizerSettings.SetOptimizerOptions 设置时才有用。

参数
[in]clean_up_options清理的优化相关选项。0表示不进行清理优化。 请参考从 foxit.addon.optimization.OptimizerSettings.CleanUpOptions.e_CleanUpUseFlateForNonEncodedStream 开始的值， 可以是这些值中的一个或组合。
返回
无。

◆ SetColorGrayImageSettings()

void foxit.addon.optimization.OptimizerSettings.SetColorGrayImageSettings ( ImageSettings  settings)
inline
弃用:
此函数从Foxit PDF SDK 10.0开始已被弃用。 此函数将不再对 OptimizerSettings 产生任何影响。 对于设置彩色图像，请调用函数 OptimizerSettings.SetColorImageSettings 。 请参考 OptimizerSettings 中与SetColorImageSettings相关的函数了解更多详细信息。 对于设置灰度图像，请调用函数 OptimizerSettings.SetGrayscaleImageSettings 。 请参考 OptimizerSettings 中与SetGrayscaleImageSettings相关的函数了解更多详细信息。

对于新构造的对象，如果不调用此函数来设置任何彩色/灰度图像设置， 那么意味着使用默认的彩色/灰度图像设置。有关默认值，请参考 类 ImageSettings 中的注释。
此函数设置的ImageSettings仅在选项值 foxit.addon.optimization.OptimizerSettings.OptimizerOptions.e_OptimizerCompressImages 被 函数 OptimizerSettings.SetOptimizerOptions 设置时才有用。

参数
[in]settings彩色和灰度图像的优化相关设置。
返回
无。

◆ SetColorImageSettings()

void foxit.addon.optimization.OptimizerSettings.SetColorImageSettings ( ImageSettings  settings)
inline

设置彩色图像的优化相关设置。

对于新构造的对象，如果不调用此函数来设置任何彩色图像设置， 那么意味着使用默认的彩色图像设置。有关默认值，请参考 类 ImageSettings 中的注释。
此函数设置的ImageSettings仅在选项值 foxit.addon.optimization.OptimizerSettings.OptimizerOptions.e_OptimizerCompressImages 被 函数 OptimizerSettings.SetOptimizerOptions 设置时才有用。

参数
[in]settings彩色图像的优化相关设置。
返回
无。

◆ SetDiscardObjectsOptions()

void foxit.addon.optimization.OptimizerSettings.SetDiscardObjectsOptions ( int  discard_objects_options)
inline

设置丢弃对象的优化相关选项。

对于新构造的对象，如果不调用此函数来设置任何丢弃对象选项， 那么意味着不进行丢弃对象优化。 此函数设置的丢弃对象选项仅在选项值 foxit.addon.optimization.OptimizerSettings.OptimizerOptions.e_OptimizerDiscardObjects 被 函数 OptimizerSettings.SetOptimizerOptions 设置时才有用。

参数
[in]discard_objects_options丢弃对象的优化相关选项。 0表示不进行丢弃对象优化。请参考从 foxit.addon.optimization.OptimizerSettings.DiscardObjectsOptions.e_DiscardObjectsFormActions 开始的值， 可以是这些值中的一个或组合。
返回
无。

◆ SetDiscardUserDataOptions()

void foxit.addon.optimization.OptimizerSettings.SetDiscardUserDataOptions ( int  discard_userdata_options)
inline

设置丢弃用户数据的优化相关选项。

对于新构造的对象，如果不调用此函数来设置任何丢弃用户数据选项， 那么意味着不进行丢弃用户数据优化。 此函数设置的丢弃用户数据选项仅在选项值 foxit.addon.optimization.OptimizerSettings.OptimizerOptions.e_OptimizerDiscardUserData 被 函数 OptimizerSettings.SetOptimizerOptions 设置时才有用。

参数
[in]discard_userdata_options丢弃用户数据的优化相关选项。 0表示不进行丢弃用户数据优化。请参考从 foxit.addon.optimization.OptimizerSettings.DiscardUserDataOptions.e_DiscardUserDataAllAnnotsFormsAndMultimedia 开始的值，可以是这些值中的一个或组合。
返回
无。

◆ SetGrayscaleImageSettings()

void foxit.addon.optimization.OptimizerSettings.SetGrayscaleImageSettings ( ImageSettings  settings)
inline

设置灰度图像的优化相关设置。

对于新构造的对象，如果不调用此函数来设置任何灰度图像设置， 那么意味着使用默认的灰度图像设置。有关默认值，请参考 类 ImageSettings 中的注释。
此函数设置的 ImageSettings 仅在选项值 foxit.addon.optimization.OptimizerSettings.OptimizerOptions.e_OptimizerCompressImages 被 函数 OptimizerSettings.SetOptimizerOptions 设置时才有用。

参数
[in]settings灰度图像的优化相关设置。
返回
无。

◆ SetMonoImageSettings()

void foxit.addon.optimization.OptimizerSettings.SetMonoImageSettings ( MonoImageSettings  settings)
inline

设置单色图像的优化相关设置。

对于新构造的对象，如果不调用此函数来设置任何单色图像设置， 那么意味着使用默认的单色图像设置。 有关详细值，请参考类 MonoImageSettings 中的注释。
此函数设置的MonoImageSettings仅在选项值 foxit.addon.optimization.OptimizerSettings.OptimizerOptions.e_OptimizerCompressImages 被 函数 OptimizerSettings.SetOptimizerOptions 设置时才有用。

参数
[in]settings单色图像的优化相关设置。
返回
无。

◆ SetOptimizerOptions()

void foxit.addon.optimization.OptimizerSettings.SetOptimizerOptions ( int  optimize_options)
inline

设置选项以决定用于优化PDF文档的优化器设置类型。

对于新构造的对象，如果不调用此函数来设置任何优化器选项， 那么意味着没有任何类型的优化器设置有用。

参数
[in]optimize_options决定用于优化PDF文档的优化器设置类型的选项。 0表示没有任何类型的优化器设置有用。请参考从 foxit.addon.optimization.OptimizerSettings.OptimizerOptions.e_OptimizerCompressImages 开始的值， 可以是这些值中的一个或组合。
返回
无。

◆ SetTransparencyMode()

void foxit.addon.optimization.OptimizerSettings.SetTransparencyMode ( OptimizerSettings.TransparencyMode  transparency_mode)
inline

设置优化透明度模式。

对于新构造的对象，如果不调用此函数来设置任何丢弃对象选项， 那么意味着不进行丢弃对象优化。 此函数设置的丢弃对象选项仅在选项值 foxit.addon.optimization.OptimizerSettings.OptimizerOptions.e_OptimizerDiscardObjects 被 函数 OptimizerSettings.SetOptimizerOptions 设置时才有用。

参数
[in]transparency_mode优化透明度选项。 请参考值从 foxit.addon.optimization.OptimizerSettings.TransparencyMode.e_TransparencyModeLowResolution ， 它的值必须是这些值中的一个，默认值为： foxit.addon.optimization.OptimizerSettings.TransparencyMode.e_TransparencyModeLowResolution 。
返回
无。

◆ SetUnembeddedFontSettings()

void foxit.addon.optimization.OptimizerSettings.SetUnembeddedFontSettings ( UnembeddedFontSettings  settings)
inline

设置取消嵌入字体的优化相关设置。

对于新构造的对象，如果不调用此函数来设置任何非嵌入字体设置， 那么意味着不取消嵌入任何字体。 此函数设置的UnembeddedFontSettings仅在选项值 foxit.addon.optimization.OptimizerSettings.OptimizerOptions.e_OptimizerUnembeddedFonts 被 函数 OptimizerSettings.SetOptimizerOptions 设置时才有用。

参数
[in]settings取消嵌入字体的优化相关设置。
返回
无。