FSDK::AnnotationSummary类 参考

Public 成员函数
	constructor (document)
	构造函数。 更多...
	IsEmpty ()
	检查当前对象是否为空。 更多...
	SetCallback (callback)
	为注释摘要设置回调对象。 更多...
	StartSummarize (dest_file, settings, pause)
	开始汇总注释。 更多...
	StartSummarize (dest_file_path, settings, pause)
	开始汇总注释。 更多...
	StartSummarize (dest_file_path, settings, pause)
	开始汇总注释。 更多...

详细描述

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

成员函数说明

constructor()

FSDK::AnnotationSummary::constructor

(

document

)

构造函数。

参数

[in]

document

有效的 PDF 文档。它应该已成功加载。

IsEmpty()

FSDK::AnnotationSummary::IsEmpty

(

)

检查当前对象是否为空。

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

返回

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

SetCallback()

FSDK::AnnotationSummary::SetCallback

(

callback

)

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

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

参数

[in]

callback

由用户实现的 FSDK.AnnotationSummaryCallback 对象。 用户可以通过此回调在汇总注释期间更改某些信息/数据。 请确保回调对象在当前 AnnotationSummary 对象的生命周期结束之前保持有效。 如果为 null，表示使用默认信息/数据。

返回

无。

StartSummarize() [1/3]

FSDK::AnnotationSummary::StartSummarize	(	dest_file	,
		settings	,
		pause
	)

开始汇总注释。

汇总注释可能需要很长时间，因此 Foxit PDF SDK 使用渐进式过程来执行此操作。 如果相关源 PDF 文档没有任何支持的类型的注释（请参阅函数 FSDK.AnnotationSummarySettings.SetAnnotType 的注释），或相关源 PDF 文档没有任何注释， 此函数将抛出异常 FSDK.e_ErrUnknown。

参数

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

返回

渐进式对象。请通过函数 FSDK.Progressive.GetRateOfProgress 检查当前进度的速率。如果速率尚未达到 100，请调用函数 FSDK.Progressive.Continue 继续进度，直到进度完成。

StartSummarize() [2/3]

FSDK::AnnotationSummary::StartSummarize	(	dest_file_path	,
		settings	,
		pause
	)

开始汇总注释。

汇总注释可能需要很长时间，因此 Foxit PDF SDK 使用渐进式过程来执行此操作。 如果相关源 PDF 文档没有任何支持的类型的注释（请参阅函数 FSDK.AnnotationSummarySettings.SetAnnotType 的注释），或相关源 PDF 文档没有任何注释， 此函数将抛出异常 FSDK.e_ErrUnknown。

参数

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

返回

渐进式对象。请通过函数 FSDK.Progressive.GetRateOfProgress 检查当前进度的速率。如果速率尚未达到 100，请调用函数 FSDK.Progressive.Continue 继续进度，直到进度完成。

StartSummarize() [3/3]

FSDK::AnnotationSummary::StartSummarize	(	dest_file_path	,
		settings	,
		pause
	)

开始汇总注释。

汇总注释可能需要很长时间，因此 Foxit PDF SDK 使用渐进式过程来执行此操作。 如果相关源 PDF 文档没有任何支持的类型的注释（请参阅函数 FSDK.AnnotationSummarySettings.SetAnnotType 的注释），或相关源 PDF 文档没有任何注释， 此函数将抛出异常 FSDK.e_ErrUnknown。

参数

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

返回

渐进式对象。请通过函数 FSDK.Progressive.GetRateOfProgress 检查当前进度的速率。如果速率尚未达到 100，请调用函数 FSDK.Progressive.Continue 继续进度，直到进度完成。