Foxit PDF SDK

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

## Public 成员函数
| constructor (base_doc, compared_doc)
| 从 PDF 文档对象构造。 更多...
| DoCompare (base_page_index, compared_page_index, compare_flags)
| 将基准文档的 PDF 页面与比较文档中的 PDF 页面进行比较。“基准文档”和“比较文档”指 用于构造当前对象的 PDF 文档对象。 更多...
| GenerateComparedDoc (compare_flags)
| 比较基准文档与比较文档（用于构造当前对象）， 然后生成一个 PDF 文档作为比较结果。 更多...
| GenerateComparedDoc (compare_flags, is_show_all_layers)
| 比较基准文档与比较文档（用于构造当前对象）， 然后生成一个 PDF 文档作为比较结果。 更多...
| IsEmpty ()
| 检查当前对象是否为空。 更多...

## 静态 Public 属性
static | e_CompareTypeAll
| 比较类型标志的枚举。 更多...
static | e_CompareTypeAnnotation
| 仅比较注释。
static | e_CompareTypeText
| 仅比较文本。

## 详细描述

此类可用于逐页地将一个 PDF 文件（作为“基准文档”）与另一个 PDF 文件（作为“比较文档”）进行比较。

## 成员函数说明

## ◆ constructor()

FSDK::Comparison::constructor | ( | base_doc | ,
|  | compared_doc |
| ) |  |

从 PDF 文档对象构造。

参数

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

注解
  如果在函数 FSDK.Library.Initialize 中使用的许可信息中未定义模块“Comparison”， 则表示用户没有使用比较相关函数的权限， 此构造函数将抛出异常 FSDK.e_ErrNoComparisonModuleRight。

## ◆ DoCompare()

FSDK::Comparison::DoCompare | ( | base_page_index | ,
|  | compared_page_index | ,
|  | compare_flags |
| ) |  |

将基准文档的 PDF 页面与比较文档中的 PDF 页面进行比较。“基准文档”和“比较文档”指 用于构造当前对象的 PDF 文档对象。

参数

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

返回
  一个 FSDK.CompareResults 对象。

## ◆ GenerateComparedDoc() [1/2]

FSDK::Comparison::GenerateComparedDoc | ( | compare_flags |  | ) |

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

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

参数

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

返回
  一个 FSDK.PDFDoc 对象，表示输出的比较 PDF 文档。

## ◆ GenerateComparedDoc() [2/2]

FSDK::Comparison::GenerateComparedDoc | ( | compare_flags | ,
|  | is_show_all_layers |
| ) |  |

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

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

参数

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

返回
  一个 FSDK.PDFDoc 对象，表示输出的比较 PDF 文档。

## ◆ IsEmpty()

FSDK::Comparison::IsEmpty | ( |  | ) |

检查当前对象是否为空。

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

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

## 类成员变量说明

## ◆ e_CompareTypeAll

FSDK::Comparison::e_CompareTypeAll
| static

比较类型标志的枚举。

此枚举的值可以单独使用，某些值可以组合使用。

比较所有内容。此值应该单独使用。