Foxit PDF SDK

Public 类型 | Public 成员函数 | 所有成员列表
foxit.addon.optimization.MonoImageSettings类 参考
类 foxit.addon.optimization.MonoImageSettings 继承关系图:

## Public 类型
enum | MonoImageCompressMode { MonoImageCompressMode.e_ImageCompressCCITT3 = 10001, MonoImageCompressMode.e_ImageCompressCCITT4 = 10002, MonoImageCompressMode.e_ImageCompressHigh = 10003, MonoImageCompressMode.e_ImageCompressjbig2 = 10004, MonoImageCompressMode.e_ImageCompressRetain = 10007, MonoImageCompressMode.e_ImageCompressRunLength = 10008, MonoImageCompressMode.e_ImageCompressZip = 10009 }
| 用于单色图像的压缩模式枚举。 更多...
enum | MonoImageCompressQuality { MonoImageCompressQuality.e_ImageCompressQualityLossless = 1, MonoImageCompressQuality.e_ImageCompressQualityLossy = 2, MonoImageCompressQuality.e_ImageCompressQualityMinimum = 3, MonoImageCompressQuality.e_ImageCompressQualityLow = 4, MonoImageCompressQuality.e_ImageCompressQualityMedium = 5, MonoImageCompressQuality.e_ImageCompressQualityHigh = 6, MonoImageCompressQuality.e_ImageCompressQualityMaximum = 7 }
| 用于单色图像的压缩质量枚举。 更多...
enum | StretchMode { StretchMode.e_StretchDefault = -1, StretchMode.e_StretchOff = 0x00, StretchMode.e_StretchInterpol = 0x20, StretchMode.e_StretchDownsample = 0x04, StretchMode.e_StretchBicubic = 0x80, StretchMode.e_StretchNoSmooth = 0x100 }
| 拉伸模式的枚举。 更多...

## Public 成员函数
| MonoImageSettings ()
| 构造函数。 更多...
| MonoImageSettings (MonoImageSettings other)
| 构造函数，使用另一个结果信息对象。 更多...
bool | IsEmpty ()
| 检查当前对象是否为空。 更多...
void | SetCompressionMode (MonoImageSettings.MonoImageCompressMode mode)
| 设置用于优化PDF文档中单色图像的压缩模式。 更多...
void | SetImageDPI (int dpi)
| 设置DPI值作为压缩PDF文档中单色图像的目标压缩值。 更多...
void | SetImageDPILimit (int dpi_limit)
| 设置单色图像的下限DPI值，以决定是否压缩PDF文档中的图像。 更多...
void | SetQuality (MonoImageSettings.MonoImageCompressQuality quality)
| 设置压缩质量，用于优化PDF文档中的单色图像。 更多...
void | SetStretchMode (MonoImageSettings.StretchMode mode)
| 设置用于优化PDF文档中单色图像的拉伸模式。 更多...

## 详细描述

此类表示单色图像的降采样/重压缩设置。 此类对象可以设置到类 OptimizerSettings 中，然后用于优化PDF文档。

参见
  OptimizerSettings

## 成员枚举类型说明

## ◆ MonoImageCompressMode

enum foxit.addon.optimization.MonoImageSettings.MonoImageCompressMode
| strong

用于单色图像的压缩模式枚举。

此枚举的值应单独使用。

枚举值
e_ImageCompressCCITT3 | 压缩模式：CCITT Group 3。
e_ImageCompressCCITT4 | 压缩模式：CCITT Group 4。
e_ImageCompressHigh | 压缩模式：高压缩。
e_ImageCompressjbig2 | 压缩模式：JBIG2。
e_ImageCompressRetain | 压缩模式：保持原样，即不压缩。
e_ImageCompressRunLength | 压缩模式：行程编码。
e_ImageCompressZip | 压缩模式：ZIP。

## ◆ MonoImageCompressQuality

enum foxit.addon.optimization.MonoImageSettings.MonoImageCompressQuality
| strong

用于单色图像的压缩质量枚举。

此枚举的值应单独使用。

枚举值
e_ImageCompressQualityLossless | 压缩质量：无损。
e_ImageCompressQualityLossy | 压缩质量：有损。
e_ImageCompressQualityMinimum | 压缩质量：最小，仅适用于e_ImageCompressHigh压缩模式。
e_ImageCompressQualityLow | 压缩质量：低，仅适用于e_ImageCompressHigh压缩模式。
e_ImageCompressQualityMedium | 压缩质量：中等，仅适用于e_ImageCompressHigh压缩模式。
e_ImageCompressQualityHigh | 压缩质量：高，仅适用于e_ImageCompressHigh压缩模式。
e_ImageCompressQualityMaximum | 压缩质量：最大，仅适用于e_ImageCompressHigh压缩模式。

## ◆ StretchMode

enum foxit.addon.optimization.MonoImageSettings.StretchMode
| strong

拉伸模式的枚举。

此枚举的值应单独使用。

枚举值
e_StretchDefault | 当设置此值时，表示进行默认拉伸。
e_StretchOff | 当设置此值时，表示不进行拉伸。
e_StretchInterpol | 当设置此值时，表示进行缩放插值。
e_StretchDownsample | 当设置此值时，表示在缩小或旋转时不进行半色调处理。
e_StretchBicubic | 当设置此值时，表示进行双三次插值缩放。
e_StretchNoSmooth | 当设置此值时，表示拉伸时不进行任何插值。

## 构造及析构函数说明

## ◆ MonoImageSettings() [1/2]

foxit.addon.optimization.MonoImageSettings.MonoImageSettings | ( |  | ) |
| inline

构造函数。

此构造函数用于构造具有默认设置选项的单色图像设置对象。 用户也可以调用此类中的"set"方法来更改这些设置选项。 有关默认值的更多详细信息，请参考这些"set"方法的注释。

## ◆ MonoImageSettings() [2/2]

foxit.addon.optimization.MonoImageSettings.MonoImageSettings | ( | MonoImageSettings | other | ) |
| inline

构造函数，使用另一个结果信息对象。

参数

  [in] | other | 另一个单色图像设置对象。

## 成员函数说明

## ◆ IsEmpty()

bool foxit.addon.optimization.MonoImageSettings.IsEmpty | ( |  | ) |
| inline

检查当前对象是否为空。

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

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

## ◆ SetCompressionMode()

void foxit.addon.optimization.MonoImageSettings.SetCompressionMode | ( | MonoImageSettings.MonoImageCompressMode | mode | ) |
| inline

设置用于优化PDF文档中单色图像的压缩模式。

对于新构造的对象，如果不调用此函数来设置选项， 那么将使用 foxit.addon.optimization.MonoImageSettings.MonoImageCompressMode.e_ImageCompressCCITT4 作为此选项的默认值。

参数

  [in] | mode | 图像压缩模式。请参考从 foxit.addon.optimization.MonoImageSettings.MonoImageCompressMode.e_ImageCompressHigh 开始的值， 应该是这些值中的一个。

返回
  无。

## ◆ SetImageDPI()

void foxit.addon.optimization.MonoImageSettings.SetImageDPI | ( | int | dpi | ) |
| inline

设置DPI值作为压缩PDF文档中单色图像的目标压缩值。

当图像可以被压缩时，此图像的分辨率将被压缩到当前函数设置的DPI值。
对于新构造的对象，如果不调用此函数来设置选项， 那么将使用250作为此选项的默认值。

参数

  [in] | dpi | DPI值。如果图像可以被压缩，这些图像的分辨率将被压缩到此值。

返回
  无。

## ◆ SetImageDPILimit()

void foxit.addon.optimization.MonoImageSettings.SetImageDPILimit | ( | int | dpi_limit | ) |
| inline

设置单色图像的下限DPI值，以决定是否压缩PDF文档中的图像。

如果PDF文档中图像的分辨率高于下限DPI值，此图像将被压缩到 通过函数 MonoImageSettings.SetImageDPI 设置的目标压缩DPI值。
对于新构造的对象，如果不调用此函数来设置选项， 那么将使用一个DPI值（目标压缩DPI值的1.5倍）作为 此选项的默认值。

参数

  [in] | dpi_limit | 作为下限的DPI值。此值应该是正数。建议范围： 大于目标压缩DPI值（通过函数 MonoImageSettings.SetImageDPI 设置）， 最大值是目标压缩DPI值的10倍。 如果输入值不大于目标压缩DPI值，将使用比目标压缩DPI值多1的DPI值。 如果输入值大于最大值，将使用最大值。

返回
  无。

## ◆ SetQuality()

void foxit.addon.optimization.MonoImageSettings.SetQuality | ( | MonoImageSettings.MonoImageCompressQuality | quality | ) |
| inline

设置压缩质量，用于优化PDF文档中的单色图像。

对于新构造的对象，如果不调用此函数来设置此选项， 那么将使用 foxit.addon.optimization.MonoImageSettings.MonoImageCompressQuality.e_ImageCompressQualityLossless 作为此选项的默认值。

参数

  [in] | quality | 压缩质量。请参考从 foxit.addon.optimization.MonoImageSettings.MonoImageCompressQuality.e_ImageCompressQualityLossless 开始的值，应该是这些值中的一个。

返回
  无。

## ◆ SetStretchMode()

void foxit.addon.optimization.MonoImageSettings.SetStretchMode | ( | MonoImageSettings.StretchMode | mode | ) |
| inline

设置用于优化PDF文档中单色图像的拉伸模式。

对于新构造的对象，如果不调用此函数来设置此选项， 那么将使用 foxit.addon.optimization.MonoImageSettings.StretchMode.e_StretchBicubic 作为此选项的默认值。

参数

  [in] | mode | 拉伸模式。请参考从 foxit.addon.optimization.ImageSettings.StretchMode.e_StretchOff 开始的值， 应该是这些值中的一个。

返回
  无。