Foxit PDF SDK

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

## Public 成员函数
| constructor (pdf_doc)
| 带参数的构造函数。 更多...
| EnableSimulateOverprint (is_to_simulate_overprint)
| 设置标志以决定是否启用叠印模拟。 更多...
| GeneratePreviewBitmap (page, matrix, renderer)
| 为PDF页面生成输出预览位图。 更多...
| GetPlates (colorant_type)
| 获取分色版。 更多...
| GetSpotPlateColor (plate_name)
| 获取版的颜色值。 更多...
| IsChecked (plate_name)
| 检查版是否被选中。 更多...
| IsEmpty ()
| 检查当前对象是否为空。 更多...
| SetCheckStatus (plate_name, to_check)
| 设置版的选中状态。 更多...
| SetShowType (show_type)
| 设置显示类型。 更多...
| SetSimulationProfile (icc_profile_path)
| 设置模拟ICC配置文件路径。 更多...

## 静态 Public 属性
static | e_ColorantTypeProcess
| 着色剂类型的枚举。 更多...
static | e_ColorantTypeSpot
| 着色剂类型：专色。
static | e_ShowAll
| 显示类型的枚举。 更多...
static | e_ShowCalGray
| 如果设置，仅显示CalGray。
static | e_ShowCalibrated
| 如果设置，仅显示校准颜色。
static | e_ShowCMYK
| 如果设置，仅显示CMYK。
static | e_ShowDevice
| 如果设置，仅显示设备颜色。
static | e_ShowDeviceCMYK
| 如果设置，仅显示DeviceCMYK。
static | e_ShowDeviceCMYKAndSpot
| 如果设置，仅显示DeviceCMYK和专色。
static | e_ShowDeviceGray
| 如果设置，仅显示DeviceGray。
static | e_ShowDeviceN
| 如果设置，仅显示DeviceN。
static | e_ShowDeviceRGB
| 如果设置，仅显示DeviceRGB。
static | e_ShowGray
| 如果设置，仅显示灰度。
static | e_ShowICCBasedCMYK
| 如果设置，仅显示基于ICC的CMYK。
static | e_ShowICCBasedRGB
| 如果设置，仅显示基于ICC的RGB。
static | e_ShowImages
| 如果设置，仅显示图像。
static | e_ShowLab
| 如果设置，仅显示Lab。
static | e_ShowLineArt
| 如果设置，仅显示线条艺术。
static | e_ShowNotDeviceCMYK
| 如果设置，仅显示非DeviceCMYK。
static | e_ShowNotDeviceCMYKOrSpot
| 如果设置，仅显示DeviceCMYK或专色。
static | e_ShowRegistrationColor
| 如果设置，仅显示套准色。
static | e_ShowRGB
| 如果设置，仅显示RGB。
static | e_ShowSmoothShades
| 如果设置，仅显示平滑着色。
static | e_ShowSolidColor
| 如果设置，仅显示纯色。
static | e_ShowSpotColor
| 如果设置，仅显示专色。
static | e_ShowText
| 如果设置，仅显示文本。

## 详细描述

此类可用于进行输出预览。输出预览用于预览分色效果和测试不同的颜色配置文件。 在使用此类之前，请确保已成功调用函数 FSDK.Library.SetDefaultICCProfilesPath； 否则在使用此类进行输出预览时可能会出现意外错误或结果。 目前，此功能在Linux ARM和Mac ARM平台上不受支持。

## 成员函数说明

## ◆ constructor()

FSDK::OutputPreview::constructor | ( | pdf_doc |  | ) |

带参数的构造函数。

参数

  [in] | pdf_doc | 有效的PDF文档对象。

## ◆ EnableSimulateOverprint()

FSDK::OutputPreview::EnableSimulateOverprint | ( | is_to_simulate_overprint |  | ) |

设置标志以决定是否启用叠印模拟。

如果未调用此函数，将使用默认值 true。

参数

  [in] | is_to_simulate_overprint | true 表示模拟叠印。 false 表示不模拟叠印。

返回
  无。

## ◆ GeneratePreviewBitmap()

FSDK::OutputPreview::GeneratePreviewBitmap | ( | page | ,
|  | matrix | ,
|  | renderer |
| ) |  |

为PDF页面生成输出预览位图。

此函数将使用输入 renderer 中指定的标志和选项以及当前输出预览对象的设置来渲染目标PDF页面， 然后返回最终的输出预览位图。此函数中的渲染过程不会影响输入的 renderer。
请确保已成功调用函数 FSDK.OutputPreview.SetSimulationProfile；否则此函数将抛出 FSDK.e_ErrUnsupported。

参数

  [in] | page | 有效的PDF页面对象。此PDF页面应已解析。
  [in] | matrix | 用于渲染的转换矩阵，通常由函数 FSDK.PDFPage.GetDisplayMatrix 返回。
  [in] | renderer | 有效的渲染器对象。

返回
  表示输出预览结果的位图。

## ◆ GetPlates()

FSDK::OutputPreview::GetPlates | ( | colorant_type |  | ) |

获取分色版。

如果要获取印刷色着色剂类型的版，请确保已成功调用函数 FSDK.OutputPreview.SetSimulationProfile； 否则将不会检索到印刷色着色剂类型的版。

参数

  [in] | colorant_type | 着色剂类型。请参考从 FSDK.OutputPreview.e_ColorantTypeProcess 开始的值，应为这些值之一。

返回
  表示版名称的字符串数组。

## ◆ GetSpotPlateColor()

FSDK::OutputPreview::GetSpotPlateColor | ( | plate_name |  | ) |

获取版的颜色值。

此函数仅对专色着色剂类型的版有用。

参数

  [in] | plate_name | 版名称。可以从函数 FSDK.OutputPreview.GetPlates 返回的字符串数组中检索。

返回
  指定版的RGB颜色。

## ◆ IsChecked()

FSDK::OutputPreview::IsChecked | ( | plate_name |  | ) |

检查版是否被选中。

对于新构造的输出预览对象，所有版都未被选中。

参数

  [in] | plate_name | 版名称。可以从函数 FSDK.OutputPreview.GetPlates 返回的字符串数组中检索。

返回
  true 表示该版被选中，而 false 表示该版未被选中。

## ◆ IsEmpty()

FSDK::OutputPreview::IsEmpty | ( |  | ) |

检查当前对象是否为空。

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

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

## ◆ SetCheckStatus()

FSDK::OutputPreview::SetCheckStatus | ( | plate_name | ,
|  | to_check |
| ) |  |

设置版的选中状态。

参数

  [in] | plate_name | 版名称。可以从函数 FSDK.OutputPreview.GetPlates 返回的字符串数组中检索。
  [in] | to_check | 选中状态：true 表示选中该版，而 false 表示不选中该版。

返回
  无。

## ◆ SetShowType()

FSDK::OutputPreview::SetShowType | ( | show_type |  | ) |

设置显示类型。

如果未为当前对象设置显示类型，则在调用函数 FSDK.OutputPreview.GeneratePreviewBitmap 时， 默认将使用值 FSDK.OutputPreview.e_ShowAll。

参数

  [in] | show_type | 显示类型。请参考从 FSDK.OutputPreview.e_ShowAll 开始的值，应为这些值之一。

返回
  无。

## ◆ SetSimulationProfile()

FSDK::OutputPreview::SetSimulationProfile | ( | icc_profile_path |  | ) |

设置模拟ICC配置文件路径。

如果输入ICC配置文件的色彩空间不是RGB/灰度/CMYK之一，此函数将抛出 FSDK.e_ErrUnsupported。
在调用函数 FSDK.OutputPreview.GeneratePreviewBitmap 之前，应成功调用此函数。

参数

  [in] | icc_profile_path | 用作输出预览模拟配置文件的ICC配置文件的文件路径。

返回
  无。

## 类成员变量说明

## ◆ e_ColorantTypeProcess

FSDK::OutputPreview::e_ColorantTypeProcess
| static

着色剂类型的枚举。

此枚举的值应单独使用。

着色剂类型：印刷色。

## ◆ e_ShowAll

FSDK::OutputPreview::e_ShowAll
| static

显示类型的枚举。

此枚举的值应单独使用。

如果设置，显示全部。