Foxit PDF SDK

Public 成员函数 | 静态 Public 属性 | 所有成员列表
FSDK::OptimizerSettings类 参考

## Public 成员函数
| constructor ()
| 构造函数。 更多...
| IsEmpty ()
| 检查当前对象是否为空。 更多...
| SetCleanUpOptions (clean_up_options)
| 设置清理的优化相关选项。 更多...
| SetColorGrayImageSettings (settings)
| 设置彩色/灰度图像的优化相关设置。 更多...
| SetDiscardObjectsOptions (discard_objects_options)
| 设置丢弃对象的优化相关选项。 更多...
| SetDiscardUserDataOptions (discard_userdata_options)
| 设置丢弃用户数据的优化相关选项。 更多...
| SetMonoImageSettings (settings)
| 设置单色图像的优化相关设置。 更多...
| SetOptimizerOptions (optimize_options)
| 设置选项以决定将使用哪种类型的优化器设置来优化 PDF 文档。 更多...
| SetTransparencyMode (transparency_mode)
| 设置执行透明度的优化相关选项。 更多...
| SetUnembeddedFontSettings (settings)
| 设置取消嵌入字体的优化相关设置。 更多...

## 静态 Public 属性
static | e_CleanUpDiscardUnreferencedNamedDes
| 丢弃未引用的命名目标。
static | e_CleanUpOptPageContent
| 清理页面内容，将内容流中的 0A、0D 更改为空格。
static | e_CleanUpRemoveInvalidBookmarks
| 删除无效的书签。
static | e_CleanUpRemoveInvalidLinks
| 删除无效的链接。
static | e_CleanUpUseFlateForNonEncodedStream
| 用于清理选项的枚举。 更多...
static | e_CleanUpUseFlateInsteadOfLZW
| 在使用 LZW 编码的流中，改用 Flate。
static | e_DiscardObjectsAlternateImages
| 丢弃所有替代图像。 更多...
static | e_DiscardObjectsBookmarks
| 丢弃书签。
static | e_DiscardObjectsDetectAndMergeImageFragment
| 检测并合并图像片段。
static | e_DiscardObjectsDocumentTags
| 丢弃文档标签。
static | e_DiscardObjectsEmbeddedPageThumbnails
| 丢弃嵌入的页面缩略图。
static | e_DiscardObjectsEmbeddedPrintSettings
| 丢弃嵌入的打印设置。
static | e_DiscardObjectsEmbeddedSearchIndex
| 丢弃嵌入的搜索索引。
static | e_DiscardObjectsFlattenFormFields
| 将表单字段平面化。
static | e_DiscardObjectsFormActions
| 用于丢弃对象选项的枚举。 更多...
static | e_DiscardObjectsJavaScriptActions
| 丢弃所有 JavaScript 操作。 更多...
static | e_DiscardObjectsSmoothlinestocurves
| 将线条平滑为曲线。
static | e_DiscardUserAllData
| 丢弃所有标签用户数据。
static | e_DiscardUserDataAllAnnotsFormsAndMultimedia
| 用于丢弃用户数据选项的枚举。 更多...
static | e_DiscardUserDataDocumentInfoAndMetaData
| 丢弃文档信息和元数据。
static | e_DiscardUserDataExternalCrossReferences
| 丢弃外部交叉引用。
static | e_DiscardUserDataFileAttchments
| 丢弃文件附件。
static | e_DiscardUserDataLayer
| 丢弃隐藏图层内容并将可见图层平面化。
static | e_DiscardUserDataPrivateDataOfOtherApp
| 丢弃其他应用程序的私有数据。
static | e_OptimizerCleanUp
| 通过清理来优化 PDF 文档。
static | e_OptimizerCompressImages
| 用于优化器选项的枚举。 更多...
static | e_OptimizerDiscardObjects
| 通过丢弃对象来优化 PDF 文档。
static | e_OptimizerDiscardUserData
| 通过丢弃用户数据来优化 PDF 文档。
static | e_OptimizerTransparency
| 通过处理透明度来优化 PDF 文档。
static | e_OptimizerUnembeddedFonts
| 通过取消嵌入某些嵌入字体来优化 PDF 文档。
static | e_TransparencyModeHighResolution
| 透明度模式：高分辨率。 更多...
static | e_TransparencyModeLowResolution
| 用于透明度模式的枚举。 更多...
static | e_TransparencyModeMediumResolution
| 透明度模式：中分辨率。 更多...

## 详细描述

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

参见
  FSDK.Optimizer

## 成员函数说明

## ◆ constructor()

FSDK::OptimizerSettings::constructor | ( |  | ) |

构造函数。

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

## ◆ IsEmpty()

FSDK::OptimizerSettings::IsEmpty | ( |  | ) |

检查当前对象是否为空。

当当前对象为空时，表示当前对象无用。

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

## ◆ SetCleanUpOptions()

FSDK::OptimizerSettings::SetCleanUpOptions | ( | clean_up_options |  | ) |

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

对于新构造的对象，如果未调用此函数设置任何清理选项， 则表示不执行清理优化。 此函数设置的清理选项仅在通过函数 FSDK.OptimizerSettings.SetOptimizerOptions 设置了选项值 FSDK.OptimizerSettings.e_OptimizerCleanUp 时才有用。

参数

  [in] | clean_up_options | 清理的优化相关选项。0 表示不执行清理优化。 请参考从 FSDK.OptimizerSettings.e_CleanUpUseFlateForNonEncodedStream 开始的值， 这可以是这些值之一或其组合。

返回
  无。

## ◆ SetColorGrayImageSettings()

FSDK::OptimizerSettings::SetColorGrayImageSettings | ( | settings |  | ) |

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

弃用:
  自 Foxit PDF SDK 10.0 以来，此函数已被弃用。 此函数将不再对 OptimizerSettings 产生任何影响。 要设置彩色图像，请调用函数 FSDK.OptimizerSettings.SetColorImageSettings。 请参考 OptimizerSettings 中的 SetColorImageSettings 相关函数以获取更多详细信息。 要设置灰度图像，请调用函数 FSDK.OptimizerSettings.SetGrayscaleImageSettings。 请参考 OptimizerSettings 中的 SetGrayscaleImageSettings 相关函数以获取更多详细信息。

对于新构造的对象，如果未调用此函数设置任何彩色/灰度图像设置， 则表示使用默认的彩色/灰度图像设置。请参考类 FSDK.ImageSettings 中的注释以获取默认值。
此函数设置的 ImageSettings 仅在通过函数 FSDK.OptimizerSettings.SetOptimizerOptions 设置了选项值 FSDK.OptimizerSettings.e_OptimizerCompressImages 时才有用。

参数

  [in] | settings | 彩色和灰度图像的优化相关设置。

返回
  无。

## ◆ SetDiscardObjectsOptions()

FSDK::OptimizerSettings::SetDiscardObjectsOptions | ( | discard_objects_options |  | ) |

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

对于新构造的对象，如果未调用此函数设置任何丢弃对象选项， 则表示不执行丢弃对象优化。 此函数设置的丢弃对象选项仅在通过函数 FSDK.OptimizerSettings.SetOptimizerOptions 设置了选项值 FSDK.OptimizerSettings.e_OptimizerDiscardObjects 时才有用。

参数

  [in] | discard_objects_options | 丢弃对象的优化相关选项。 0 表示不执行丢弃对象优化。请参考 从 FSDK.OptimizerSettings.e_DiscardObjectsFormActions 开始的值， 这可以是这些值之一或其组合。

返回
  无。

## ◆ SetDiscardUserDataOptions()

FSDK::OptimizerSettings::SetDiscardUserDataOptions | ( | discard_userdata_options |  | ) |

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

对于新构造的对象，如果未调用此函数设置任何丢弃用户数据选项， 则表示不执行丢弃用户数据优化。 此函数设置的丢弃用户数据选项仅在通过函数 FSDK.OptimizerSettings.SetOptimizerOptions 设置了选项值 FSDK.OptimizerSettings.e_OptimizerDiscardUserData 时才有用。

参数

  [in] | discard_userdata_options | 丢弃用户数据的优化相关选项。 0 表示不执行丢弃用户数据优化。请参考 从 FSDK.OptimizerSettings.e_DiscardUserDataAllAnnotsFormsAndMultimedia 开始的值， 这可以是这些值之一或其组合。

返回
  无。

## ◆ SetMonoImageSettings()

FSDK::OptimizerSettings::SetMonoImageSettings | ( | settings |  | ) |

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

对于新构造的对象，如果未调用此函数设置任何单色图像设置， 则表示使用默认的单色图像设置。 请参考类 FSDK.ImageSettings 中的注释以获取详细值。
此函数设置的 MonoImageSettings 仅在通过函数 FSDK.OptimizerSettings.SetOptimizerOptions 设置了选项值 FSDK.OptimizerSettings.e_OptimizerCompressImages 时才有用。

参数

  [in] | settings | 单色图像的优化相关设置。

返回
  无。

## ◆ SetOptimizerOptions()

FSDK::OptimizerSettings::SetOptimizerOptions | ( | optimize_options |  | ) |

设置选项以决定将使用哪种类型的优化器设置来优化 PDF 文档。

对于新构造的对象，如果未调用此函数设置任何优化器选项， 则表示没有优化器设置是有用的。

参数

  [in] | optimize_options | 用于决定将使用哪种类型的优化器设置来优化 PDF 文档的选项。 0 表示任何类型的优化器设置都无用。请参考从 FSDK.OptimizerSettings.e_OptimizerCompressImages 开始的值，这可以是 这些值之一或其组合。

返回
  无。

## ◆ SetTransparencyMode()

FSDK::OptimizerSettings::SetTransparencyMode | ( | transparency_mode |  | ) |

设置执行透明度的优化相关选项。

对于新构造的对象，如果未调用此函数设置任何透明度模式， 则表示透明度模式默认为 FSOptimizerSettings.e_TransparencyModeLowResolution。

参数

  [in] | transparency_mode | 透明度模式的优化相关选项。 请参考从 FSOptimizerSettings.e_TransparencyModeLowResolution 开始的值， 这必须是这些值之一。默认值为 FSOptimizerSettings.e_TransparencyModeLowResolution。

返回
  无。

## ◆ SetUnembeddedFontSettings()

FSDK::OptimizerSettings::SetUnembeddedFontSettings | ( | settings |  | ) |

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

对于新构造的对象，如果未调用此函数设置任何未嵌入字体设置， 则表示不取消嵌入任何字体。 此函数设置的 UnembeddedFontSettings 仅在通过函数 FSDK.OptimizerSettings.SetOptimizerOptions 设置了选项值 FSDK.OptimizerSettings.e_OptimizerUnembeddedFonts 时才有用。

参数

  [in] | settings | 取消嵌入字体的优化相关设置。

返回
  无。

## 类成员变量说明

## ◆ e_CleanUpUseFlateForNonEncodedStream

FSDK::OptimizerSettings::e_CleanUpUseFlateForNonEncodedStream
| static

用于清理选项的枚举。

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

使用 Flate 对未编码的流进行编码。

## ◆ e_DiscardObjectsAlternateImages

FSDK::OptimizerSettings::e_DiscardObjectsAlternateImages
| static

丢弃所有替代图像。

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

## ◆ e_DiscardObjectsFormActions

FSDK::OptimizerSettings::e_DiscardObjectsFormActions
| static

用于丢弃对象选项的枚举。

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

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

## ◆ e_DiscardObjectsJavaScriptActions

FSDK::OptimizerSettings::e_DiscardObjectsJavaScriptActions
| static

丢弃所有 JavaScript 操作。

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

## ◆ e_DiscardUserDataAllAnnotsFormsAndMultimedia

FSDK::OptimizerSettings::e_DiscardUserDataAllAnnotsFormsAndMultimedia
| static

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

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

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

## ◆ e_OptimizerCompressImages

FSDK::OptimizerSettings::e_OptimizerCompressImages
| static

用于优化器选项的枚举。

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

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

## ◆ e_TransparencyModeHighResolution

FSDK::OptimizerSettings::e_TransparencyModeHighResolution
| static

透明度模式：高分辨率。

高分辨率包括：透明度级别：100；线条和文本：1200； 渐变和网格：300；将所有文本转换为轮廓：False； 将所有描边转换为轮廓：False； 裁剪复杂区域：True； 保留叠印设置：True。

## ◆ e_TransparencyModeLowResolution

FSDK::OptimizerSettings::e_TransparencyModeLowResolution
| static

用于透明度模式的枚举。

此枚举的值应单独使用。

透明度模式：低分辨率。

低分辨率包括：透明度级别：75；线条和文本：288； 渐变和网格：144；将所有文本转换为轮廓：False； 将所有描边转换为轮廓：True； 裁剪复杂区域：False； 保留叠印设置：True。

## ◆ e_TransparencyModeMediumResolution

FSDK::OptimizerSettings::e_TransparencyModeMediumResolution
| static

透明度模式：中分辨率。

中分辨率包括：透明度级别：75；线条和文本：300； 渐变和网格：150；将所有文本转换为轮廓：False； 将所有描边转换为轮廓：True； 裁剪复杂区域：True； 保留叠印设置：True。