Foxit PDF SDK

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

## 构造函数
(id) | - initWithDocument:
| 构造函数。 更多...
(id) | - initWithOther:
| 构造函数，使用另一个注释摘要对象。 更多...
(BOOL) | - isEmpty
| 检查当前对象是否为空。 更多...
(void) | - setCallback:
| 为注释摘要设置回调对象。 更多...
(FSProgressive *) | - startSummarize:settings:pause:
| 开始摘要注释。 更多...
(FSProgressive *) | - startSummarizeWithWriterCallback:settings:pause:
| 开始摘要注释。 更多...

## 详细描述

此类可用于摘要注释并生成 PDF 文件作为结果文档。

## 函数文档

## ◆ initWithDocument:()

- (id) initWithDocument: |  | (FSPDFDoc*) | document |

构造函数。

参数

  [in] | document | 有效的 PDF 文档。它应该已成功加载。

## ◆ initWithOther:()

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

构造函数，使用另一个注释摘要对象。

参数

  [in] | other | 另一个注释摘要对象。

## ◆ isEmpty()

- (BOOL) isEmpty |  |  |

检查当前对象是否为空。

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

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

## ◆ setCallback:()

- (void) setCallback: |  | (id<FSAnnotationSummaryCallback>) | callback |

为注释摘要设置回调对象。

如果不调用此函数，表示不使用回调。

参数

  [in] | callback | 用户实现的 对象。 用户可以通过此回调在摘要注释期间更改某些信息/数据。 请确保回调对象在当前 AnnotationSummary 对象的生命周期结束前保持有效。 如果这是 nil，表示使用默认信息/数据。

返回
  无。

## ◆ startSummarize:settings:pause:()

- (FSProgressive *) startSummarize: |  | (NSString *) | dest_file_path
settings: |  | (FSAnnotationSummarySettings*) | settings
pause: |  | (id<FSPauseCallback>) | pause

开始摘要注释。

摘要注释可能需要很长时间，因此 Foxit PDF SDK 使用渐进过程来执行此操作。 如果相关源 PDF 文档没有任何支持类型的注释（请参考函数 FSAnnotationSummarySettings::setAnnotType:use_all: 的注释）， 或相关源 PDF 文档没有任何注释， 此函数将抛出异常 FSErrUnknown。

参数

  [in] | dest_file_path | 保存注释摘要结果 PDF 文件的完整路径。这不应该是空字符串。
  [in] | settings | 用于摘要注释的设置数据。
  [in] | pause | 决定是否需要暂停摘要过程的暂停对象。 这可以是 nil，表示在解析过程中不暂停。 如果这不是 nil，它应该是用户实现的有效暂停对象。 默认值：nil。

返回
  渐进对象。请通过函数 FSProgressive::getRateOfProgress 检查当前进度的比率。如果比率还不是 100，调用函数 FSProgressive::resume 继续进度，直到进度完成。

## ◆ startSummarizeWithWriterCallback:settings:pause:()

- (FSProgressive *) startSummarizeWithWriterCallback: |  | (id<FSFileWriterCallback>) | dest_file
settings: |  | (FSAnnotationSummarySettings*) | settings
pause: |  | (id<FSPauseCallback>) | pause

开始摘要注释。

摘要注释可能需要很长时间，因此 Foxit PDF SDK 使用渐进过程来执行此操作。 如果相关源 PDF 文档没有任何支持类型的注释（请参考函数 FSAnnotationSummarySettings::setAnnotType:use_all: 的注释）， 或相关源 PDF 文档没有任何注释， 此函数将抛出异常 FSErrUnknown。

参数

  [in] | dest_file | 用户实现的 FSFileWriterCallback 对象， 用于以自定义方法将注释摘要数据存储到 PDF 文件作为结果。
  [in] | settings | 用于摘要注释的设置数据。
  [in] | pause | 决定是否需要暂停摘要过程的暂停对象。 这可以是 nil，表示在解析过程中不暂停。 如果这不是 nil，它应该是用户实现的有效暂停对象。 默认值：nil。

返回
  渐进对象。请通过函数 FSProgressive::getRateOfProgress 检查当前进度的比率。如果比率还不是 100，调用函数 FSProgressive::resume 继续进度，直到进度完成。