Foxit PDF SDK
fsdk.AccessibilityNavigator Class Reference

Public Member Functions

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

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.LibraryInitialize with a key including "Accessibility" module.

See also
fsdk.Library

Member Function Documentation

◆ FindNextElement()

def fsdk.AccessibilityNavigator.FindNextElement (   page_index,
  find_type,
  is_search_page 
)

Find next element.

Parameters
[in]page_indexThe page index.
[in]find_typeThe finder type. Please refer to values starting from fsdk.AccessibilityNavigatorE_FinderTypeInvalid and this should be one of these values.
[in]is_search_pageWhether to search page.
Returns
The find result object.

◆ IsEmpty()

def fsdk.AccessibilityNavigator.IsEmpty ( )

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()

def fsdk.AccessibilityNavigator.StartFindNextElement ( )

Start to find next element.

Returns
None.

◆ StopFindNextElement()

def fsdk.AccessibilityNavigator.StopFindNextElement ( )

Stop finding next element.

Returns
None.