FSDK::LRContext类 参考

Public 成员函数
	constructor (page)
	从 PDF 页面对象构造的构造函数。 更多...
	GetRootElement ()
	获取结构树的根元素。 更多...
	IsEmpty ()
	检查当前对象是否为空。 更多...
	StartParse (pause)
	开始为相关 PDF 页面解析布局识别。 更多...

详细描述

此类可用于解析布局识别以获取根元素。

成员函数说明

constructor()

FSDK::LRContext::constructor

(

page

)

从 PDF 页面对象构造的构造函数。

参数

[in]

page

有效的 PDF 页面对象。

注解

如果在函数 FSDK.Library.Initialize 中使用的许可信息中未定义模块"LayoutRecognition"， 则意味着用户没有使用布局识别相关功能的权限， 此构造函数将抛出异常 FSDK.e_ErrNoLayoutRecognitionModuleRight。

GetRootElement()

FSDK::LRContext::GetRootElement

(

)

获取结构树的根元素。

在调用此函数之前，请确保当前上下文对象已成功解析； 否则，无法检索到有效的根结构元素。

返回

根元素。

IsEmpty()

FSDK::LRContext::IsEmpty

(

)

检查当前对象是否为空。

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

返回

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

StartParse()

FSDK::LRContext::StartParse

(

pause

)

开始为相关 PDF 页面解析布局识别。

解析可能需要很长时间，因此 Foxit PDF SDK 使用渐进式过程来完成此操作。 如果在解析过程中发生任何错误，此函数将抛出异常。 请参考从 FSDK.e_ErrFile 开始的值。

参数

[in]

pause

暂停回调对象，用于决定解析过程是否需要暂停。 这可以为 null，表示在解析过程中不暂停。 如果不为 null，它应该是由用户实现的有效暂停对象。 默认值：null。

返回

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