Foxit PDF SDK

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

## 构造函数
(FSLRStructureElement *) | - getRootElement
| 获取结构树的根元素。 更多...
(id) | - initWithOther:
| 构造函数，使用另一个上下文对象。 更多...
(id) | - initWithPage:
| 构造函数，基于PDF页面对象。 更多...
(BOOL) | - isEmpty
| 检查当前对象是否为空。 更多...
(FSProgressive *) | - startParse:
| 开始解析相关PDF页面的布局识别。 更多...

## 详细描述

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

## 函数文档

## ◆ getRootElement()

- (FSLRStructureElement *) getRootElement |  |  |

获取结构树的根元素。

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

返回
  根元素。

## ◆ initWithOther:()

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

构造函数，使用另一个上下文对象。

参数

  [in] | other | 另一个上下文对象。

## ◆ initWithPage:()

- (id) initWithPage: |  | (FSPDFPage*) | page |

构造函数，基于PDF页面对象。

参数

  [in] | page | 有效的PDF页面对象。

注解
  如果在函数FSLibrary::initialize:key:中使用的许可证信息中未定义模块"LayoutRecognition"， 这意味着用户无权使用布局识别相关函数，此构造函数将抛出异常FSErrNoLayoutRecognitionModuleRight。

## ◆ isEmpty()

- (BOOL) isEmpty |  |  |

检查当前对象是否为空。

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

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

## ◆ startParse:()

- (FSProgressive *) startParse: |  | (id<FSPauseCallback>) | pause |

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

解析可能需要很长时间，所以Foxit PDF SDK使用渐进式处理过程来完成。 如果在解析过程中发生任何错误，此函数将抛出异常。 请参考类 foxit::Exception 和从 FSErrFile 开始的值。

参数

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

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