Foxit PDF SDK
foxit.addon.accessibility.AccessibilityNavigator类 参考
类 foxit.addon.accessibility.AccessibilityNavigator 继承关系图:
foxit.common.Base

Public 类型

enum  FinderType {
  FinderType.e_FinderTypeInvalid = 0, FinderType.e_FinderTypeArtifacts = 1, FinderType.e_FinderTypeUnmarkedComments = 2, FinderType.e_FinderTypeUnmarkedLinks = 3,
  FinderType.e_FinderTypeUnmarkedAnnots = 4, FinderType.e_FinderTypeUnmarkedContent = 5, FinderType.e_FinderTypeOcrSuspects = 6
}
 查找器类型枚举。 更多...
 

Public 成员函数

 AccessibilityNavigator (PDFDoc pdf_doc)
 构造函数。 更多...
 
 AccessibilityNavigator (AccessibilityNavigator other)
 构造函数,使用另一个导航器对象构造。 更多...
 
AccessibilityFindResult FindNextElement (int page_index, AccessibilityNavigator.FinderType find_type, bool is_search_page)
 查找下一个元素。 更多...
 
bool IsEmpty ()
 检查当前对象是否为空。 更多...
 
void StartFindNextElement ()
 开始查找下一个元素。 更多...
 
void StopFindNextElement ()
 停止查找下一个元素。 更多...
 

详细描述

此类用于让用户逐个遍历 PDF 文档中的可访问元素,用于在可访问性检查/修复 UI 中驱动"查找下一个元素"的导航功能。 在使用此模块中的任何类或方法之前,请确保已通过 common.Library.Initialize 函数并使用包含 "Accessibility" 模块的密钥成功初始化福昕 PDF SDK。

参见
foxit.common.Library

成员枚举类型说明

◆ FinderType

查找器类型枚举。

此枚举的值应单独使用。

枚举值
e_FinderTypeInvalid 

查找器类型:无效。

e_FinderTypeArtifacts 

查找器类型:人工元素(页面人工元素)。

e_FinderTypeUnmarkedComments 

查找器类型:未标记的批注。

e_FinderTypeUnmarkedLinks 

查找器类型:未标记的链接。

e_FinderTypeUnmarkedAnnots 

查找器类型:未标记的注释。

e_FinderTypeUnmarkedContent 

查找器类型:未标记的页面内容。

e_FinderTypeOcrSuspects 

查找器类型:OCR 检测到的疑似项。

构造及析构函数说明

◆ AccessibilityNavigator() [1/2]

foxit.addon.accessibility.AccessibilityNavigator.AccessibilityNavigator ( PDFDoc  pdf_doc)
inline

构造函数。

参数
[in]pdf_doc有效的 PDF 文档对象。

◆ AccessibilityNavigator() [2/2]

foxit.addon.accessibility.AccessibilityNavigator.AccessibilityNavigator ( AccessibilityNavigator  other)
inline

构造函数,使用另一个导航器对象构造。

参数
[in]other另一个导航器对象。

成员函数说明

◆ FindNextElement()

AccessibilityFindResult foxit.addon.accessibility.AccessibilityNavigator.FindNextElement ( int  page_index,
AccessibilityNavigator.FinderType  find_type,
bool  is_search_page 
)
inline

查找下一个元素。

参数
[in]page_index页面索引。
[in]find_type查找器类型。请参考从 foxit.addon.accessibility.AccessibilityNavigator.FinderType.e_FinderTypeInvalid 开始的值,本参数应为其中之一。
[in]is_search_page是否搜索页面。
返回
查找结果对象。

◆ IsEmpty()

bool foxit.addon.accessibility.AccessibilityNavigator.IsEmpty ( )
inline

检查当前对象是否为空。

当前对象为空时,表示当前对象不可用。

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

◆ StartFindNextElement()

void foxit.addon.accessibility.AccessibilityNavigator.StartFindNextElement ( )
inline

开始查找下一个元素。

返回
无。

◆ StopFindNextElement()

void foxit.addon.accessibility.AccessibilityNavigator.StopFindNextElement ( )
inline

停止查找下一个元素。

返回
无。