FSDK::AccessibilityChecker类 参考

Public 成员函数
	CanCheck ()
	检查当前 PDF 文档是否可以进行完整检查。 更多...
	ChangeCheckStateInResultTree (root_data, sub_item_data, new_check_state)
	在结果树中更改检查状态。 更多...
	constructor (pdf_doc)
	构造函数。 更多...
	GetTagTreeNodeIDByCheckResultItemID (page_index, item_id)
	通过检查结果项 ID 获取标签树节点 ID。 更多...
	IsEmpty ()
	检查当前对象是否为空。 更多...
	RecheckResult (check_options, root_data)
	按结果根节点重新检查。 更多...
	RecheckResult (check_options, root_data, sub_item_data)
	按子项重新检查。 更多...
	RemoveSkippedStateInResultTree (check_options, root_data, sub_item_data)
	在结果树中移除已跳过状态。 更多...
	StartCheck (check_options, report_callback, provider, pause)
	开始无障碍检查。 更多...
	UpdateCheckResultReport ()
	更新检查结果报告。 更多...
	UpdateCheckState (rule_type, check_state)
	为指定规则更新检查状态。 更多...

详细描述

此类表示 PDF 文档的无障碍检查器：运行完整的无障碍检查、重新检查结果树的部分内容、 更改/移除检查状态，以及更新检查结果报告。 在使用此模块中的任何类或方法之前，请确保 Foxit PDF SDK 已通过包含 "Accessibility"模块的密钥成功调用函数 FSDK.Library.Initialize 进行初始化。

参见

FSDK.Library

成员函数说明

CanCheck()

FSDK::AccessibilityChecker::CanCheck ( )

inline

检查当前 PDF 文档是否可以进行完整检查。

返回

true 表示文档可以进行完整检查，false 表示不可以。

ChangeCheckStateInResultTree()

FSDK::AccessibilityChecker::ChangeCheckStateInResultTree (   root_data,   sub_item_data,   new_check_state  )

inline

在结果树中更改检查状态。

参数

[in]	root_data	检查结果树的根数据。
[in]	sub_item_data	子项数据。
[in]	new_check_state	新的检查状态。

返回

更新后的检查结果项数据。

constructor()

FSDK::AccessibilityChecker::constructor (   pdf_doc )

inline

构造函数。

参数

[in]

pdf_doc

一个有效的 PDF 文档对象。

GetTagTreeNodeIDByCheckResultItemID()

FSDK::AccessibilityChecker::GetTagTreeNodeIDByCheckResultItemID (   page_index,   item_id  )

inline

通过检查结果项 ID 获取标签树节点 ID。

参数

[in]	page_index	页面索引。
[in]	item_id	检查结果项 ID。

返回

标签树节点 ID。

IsEmpty()

FSDK::AccessibilityChecker::IsEmpty ( )

inline

检查当前对象是否为空。

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

返回

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

RecheckResult() [1/2]

FSDK::AccessibilityChecker::RecheckResult (   check_options,   root_data  )

inline

按结果根节点重新检查。

参数

[in]	check_options	检查选项。
[in]	root_data	检查结果树的根数据。

返回

更新后的检查结果项数据。

RecheckResult() [2/2]

FSDK::AccessibilityChecker::RecheckResult (   check_options,   root_data,   sub_item_data  )

inline

按子项重新检查。

参数

[in]	check_options	检查选项。
[in]	root_data	检查结果树的根数据。
[in]	sub_item_data	检查结果树的子项数据。

返回

更新后的检查结果项数据。

RemoveSkippedStateInResultTree()

FSDK::AccessibilityChecker::RemoveSkippedStateInResultTree (   check_options,   root_data,   sub_item_data  )

inline

在结果树中移除已跳过状态。

参数

[in]	check_options	检查选项。
[in]	root_data	检查结果树的根数据。
[in]	sub_item_data	子项数据。

返回

更新后的检查结果项数据。

StartCheck()

FSDK::AccessibilityChecker::StartCheck (   check_options,   report_callback,   provider,   pause  )

inline

开始无障碍检查。

参数

[in]	check_options	检查选项。请参考 FSDK.AccessibilityCheckOptions。
[in]	report_callback	用于报告输出的流回调对象。此参数可以为 NULL。
[in]	provider	用于检查结果的 FSDK.AccessibilityCheckResultsCallback 对象。
[in]	pause	暂停对象。此参数可以为 NULL。

返回

一个渐进式对象。

UpdateCheckResultReport()

FSDK::AccessibilityChecker::UpdateCheckResultReport ( )

inline

更新检查结果报告。

返回

true 表示成功，false 表示不成功。

UpdateCheckState()

FSDK::AccessibilityChecker::UpdateCheckState (   rule_type,   check_state  )

inline

为指定规则更新检查状态。

参数

[in]	rule_type	检查规则类型。请参考从 FSDK.e_RuleTypeDocPermission 开始的值，此值应为这些值之一。
[in]	check_state	检查状态。请参考从 FSDK.e_CheckStateNone 开始的值，此值应为这些值之一。

返回

true 表示成功，false 表示不成功。