FSDK.AccessibilityNavigator Class Reference

Public Member Functions
	constructor (pdf_doc)
	Constructor. More...
	FindNextElement (page_index, find_type, is_search_page)
	Find next element. More...
	IsEmpty ()
	Check whether current object is empty or not. More...
	StartFindNextElement ()
	Start to find next element. More...
	StopFindNextElement ()
	Stop finding next element. More...

Static Public Attributes
static	e_FinderTypeArtifacts
	Finder type: artifacts (page artifacts).
static	e_FinderTypeInvalid
	Enumeration for finder type. More...
static	e_FinderTypeOcrSuspects
	Finder type: OCR suspects detected by OCR.
static	e_FinderTypeUnmarkedAnnots
	Finder type: unmarked annotations.
static	e_FinderTypeUnmarkedComments
	Finder type: unmarked comments.
static	e_FinderTypeUnmarkedContent
	Finder type: unmarked page content.
static	e_FinderTypeUnmarkedLinks
	Finder type: unmarked links.

Detailed Description

This class lets user walk through the accessible elements of a PDF document one by one, used to drive "find next element" navigation in an accessibility checking / fixing UI. 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

constructor()

FSDK.AccessibilityNavigator.constructor (   pdf_doc )

inline

Constructor.

Parameters

[in]

pdf_doc

A valid PDF document object.

FindNextElement()

FSDK.AccessibilityNavigator.FindNextElement (   page_index,   find_type,   is_search_page  )

inline

Find next element.

Parameters

[in]	page_index	The page index.
[in]	find_type	The finder type. Please refer to FSDK.FinderType.
[in]	is_search_page	Whether to search page.

Returns

The find result object.

IsEmpty()

FSDK.AccessibilityNavigator.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.

StartFindNextElement()

FSDK.AccessibilityNavigator.StartFindNextElement ( )

inline

Start to find next element.

Returns

None.

StopFindNextElement()

FSDK.AccessibilityNavigator.StopFindNextElement ( )

inline

Stop finding next element.

Returns

None.

Member Data Documentation

e_FinderTypeInvalid

FSDK.AccessibilityNavigator.e_FinderTypeInvalid

static

Enumeration for finder type.

Values of this enumeration should be used alone.Finder type: invalid.