FSDK.AccessibilityChecker Class Reference

Public Member Functions
	CanCheck ()
	Check whether the current PDF document can be full checked. More...
	ChangeCheckStateInResultTree (root_data, sub_item_data, new_check_state)
	Change check state in result tree. More...
	constructor (pdf_doc)
	Constructor. More...
	GetTagTreeNodeIDByCheckResultItemID (page_index, item_id)
	Get tag tree node ID by check result item ID. More...
	IsEmpty ()
	Check whether current object is empty or not. More...
	RecheckResult (check_options, root_data)
	Recheck by result root. More...
	RecheckResult (check_options, root_data, sub_item_data)
	Recheck by sub item. More...
	RemoveSkippedStateInResultTree (check_options, root_data, sub_item_data)
	Remove skipped state in result tree. More...
	StartCheck (check_options, report_callback, provider, pause)
	Start check for accessibility. More...
	UpdateCheckResultReport ()
	Update check result report. More...
	UpdateCheckState (rule_type, check_state)
	Update check state for a specified rule. More...

Detailed Description

This class represents an accessibility checker for a PDF document: run the full accessibility check, re-check parts of the result tree, change / remove check states and update the check result report. Before using any class or methods in this module, please ensure Foxit PDF SDK has been initialized successfully by function FSDK.Library.Initialize with a key including "Accessibility" module.

See also

FSDK.Library

Member Function Documentation

CanCheck()

FSDK.AccessibilityChecker.CanCheck ( )

inline

Check whether the current PDF document can be full checked.

Returns

true means the document can be full checked, while false means not.

ChangeCheckStateInResultTree()

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

inline

Change check state in result tree.

Parameters

[in]	root_data	The root data of check result tree.
[in]	sub_item_data	The sub item data.
[in]	new_check_state	The new check state.

Returns

The updated check result item data.

constructor()

FSDK.AccessibilityChecker.constructor (   pdf_doc )

inline

Constructor.

Parameters

[in]

pdf_doc

A valid PDF document object.

GetTagTreeNodeIDByCheckResultItemID()

FSDK.AccessibilityChecker.GetTagTreeNodeIDByCheckResultItemID (   page_index,   item_id  )

inline

Get tag tree node ID by check result item ID.

Parameters

[in]	page_index	The page index.
[in]	item_id	The check result item ID.

Returns

The tag tree node ID.

IsEmpty()

FSDK.AccessibilityChecker.IsEmpty ( )

inline

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns

true means current object is empty, while false means not.

RecheckResult() [1/2]

FSDK.AccessibilityChecker.RecheckResult (   check_options,   root_data  )

inline

Recheck by result root.

Parameters

[in]	check_options	The check options.
[in]	root_data	The root data of check result tree.

Returns

The updated check result item data.

RecheckResult() [2/2]

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

inline

Recheck by sub item.

Parameters

[in]	check_options	The check options.
[in]	root_data	The root data of check result tree.
[in]	sub_item_data	The sub item data of check result tree.

Returns

The updated check result item data.

RemoveSkippedStateInResultTree()

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

inline

Remove skipped state in result tree.

Parameters

[in]	check_options	The check options.
[in]	root_data	The root data of check result tree.
[in]	sub_item_data	The sub item data.

Returns

The updated check result item data.

StartCheck()

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

inline

Start check for accessibility.

Parameters

[in]	check_options	The check options. Please refer to FSDK.AccessibilityCheckOptions.
[in]	report_callback	A stream callback object for report output. This can be NULL.
[in]	provider	An FSDK.AccessibilityCheckResultsCallback object for check results.
[in]	pause	A pause object. This can be NULL.

Returns

A progressive object.

UpdateCheckResultReport()

FSDK.AccessibilityChecker.UpdateCheckResultReport ( )

inline

Update check result report.

Returns

true means success, while false means not.

UpdateCheckState()

FSDK.AccessibilityChecker.UpdateCheckState (   rule_type,   check_state  )

inline

Update check state for a specified rule.

Parameters

[in]	rule_type	The check rule type. Please refer to values starting from FSDK.e_RuleTypeDocPermission and this should be one of these values.
[in]	check_state	The check state. Please refer to values starting from FSDK.e_CheckStateNone and this should be one of these values.

Returns

true means success, while false means not.