Foxit PDF SDK

构造函数 | 所有成员列表
FSComparison类 参考
类 FSComparison 继承关系图:

## 构造函数
(FSCompareResults *) | - doCompare:compared_page_index:compare_flags:
| 比较基本文档的PDF页面与比较文档中的PDF页面。"基本文档"和"比较文档"指用于构造当前对象的PDF文档对象。 更多...
(FSPDFDoc *) | - generateComparedDoc:
| 比较基本文档与比较文档（用于构造当前对象），然后生成PDF文档作为比较结果。 更多...
(FSPDFDoc *) | - GenerateComparedDocWithIsShowAllLayers:is_show_all_layers:
| 比较基本文档与比较文档（用于构造当前对象），然后生成PDF文档作为比较结果。 更多...
(id) | - initWithBase_doc:compared_doc:
| 从PDF文档对象构造。 更多...
(id) | - initWithOther:
| 带另一个比较对象的构造函数。 更多...
(BOOL) | - isEmpty
| 检查当前对象是否为空。 更多...

## 详细描述

此类可用于逐页比较一个PDF文件（作为"基本文档"）与另一个PDF文件（作为"比较文档"）。

## 函数文档

## ◆ doCompare:compared_page_index:compare_flags:()

- (FSCompareResults *) doCompare: |  | (int) | base_page_index
compared_page_index: |  | (int) | compared_page_index
compare_flags: |  | (unsigned int) | compare_flags

比较基本文档的PDF页面与比较文档中的PDF页面。"基本文档"和"比较文档"指用于构造当前对象的PDF文档对象。

参数

  [in] | base_page_index | 基本文档中的页面索引。有效范围：从0到(base_page_count-1)。 base_page_count由基本文档的函数FSPDFDoc::getPageCount返回。
  [in] | compared_page_index | 比较文档中的页面索引。有效范围：从0到(compared_page_count-1)。 compared_page_count由比较文档的函数FSPDFDoc::getPageCount返回。
  [in] | compare_flags | 比较类型，指定在PDF页面中要比较的内容。请参考从 FSComparisonCompareTypeAll开始的值，这可以是这些值中的一个或某些值的组合。

返回
  FSCompareResults对象。

## ◆ generateComparedDoc:()

- (FSPDFDoc *) generateComparedDoc: |  | (unsigned int) | compare_flags |

比较基本文档与比较文档（用于构造当前对象），然后生成PDF文档作为比较结果。

比较两个PDF文档的内容并生成新PDF文档可能需要很长时间。

参数

  [in] | compare_flags | 比较类型，指定在PDF页面中要比较的内容。请参考从 FSComparisonCompareTypeAll开始的值，这可以是这些值中的一个或组合。

返回
  FSPDFDoc对象，表示输出的比较PDF文档。

## ◆ GenerateComparedDocWithIsShowAllLayers:is_show_all_layers:()

- (FSPDFDoc *) GenerateComparedDocWithIsShowAllLayers: |  | (unsigned int) | compare_flags
is_show_all_layers: |  | (BOOL) | is_show_all_layers

比较基本文档与比较文档（用于构造当前对象），然后生成PDF文档作为比较结果。

比较两个PDF文档的内容并生成新PDF文档可能需要很长时间。

参数

  [in] | compare_flags | 比较类型，指定在PDF页面中要比较的内容。请参考从 FSComparisonCompareTypeAll开始的值，这可以是这些值中的一个或组合。
  [in] | is_show_all_layers | 布尔值，用于决定是否显示所有比较结果图层。 YES表示默认显示所有比较结果图层，NO表示默认仅显示 "文本"和"图像"比较结果图层。

返回
  FSPDFDoc对象，表示输出的比较PDF文档。

## ◆ initWithBase_doc:compared_doc:()

- (id) initWithBase_doc: |  | (FSPDFDoc*) | base_doc
compared_doc: |  | (FSPDFDoc*) | compared_doc

从PDF文档对象构造。

参数

  [in] | base_doc | 作为基本文档的有效PDF文档对象。
  [in] | compared_doc | 作为比较文档的有效PDF文档对象。

注解
  如果在函数FSLibrary::initialize:key:中使用的许可证信息中未定义 "Comparison"模块，意味着用户无权使用比较相关功能， 此构造函数将抛出异常FSErrNoComparisonModuleRight。

## ◆ initWithOther:()

- (id) initWithOther: |  | (FSComparison*) | other |

带另一个比较对象的构造函数。

参数

  [in] | other | 另一个比较对象。

## ◆ isEmpty()

- (BOOL) isEmpty |  |  |

检查当前对象是否为空。

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

返回
  YES表示当前对象为空，NO表示不为空。