Foxit PDF SDK
foxit.addon.accessibility.ReadingOrderOptions Class Reference

Inherits SystemIDisposable.

Public Types

enum  ReadingOrderShowType { ReadingOrderShowType.e_ReadingOrderShowTypeOrder = 0, ReadingOrderShowType.e_ReadingOrderShowTypeStruct = 1, ReadingOrderShowType.e_ReadingOrderShowTypeNone = 2 }
 Enumeration for reading order show type. More...
 

Public Member Functions

 ReadingOrderOptions ()
 Constructor.
 
 ReadingOrderOptions (ReadingOrderOptions.ReadingOrderShowType reading_order_show_type, bool is_show_table_figure, bool is_display_like_element, bool is_show_table_cells)
 Constructor.
 
 ReadingOrderOptions (ReadingOrderOptions other)
 Constructor, with another reading order options object. More...
 
void Set (ReadingOrderOptions.ReadingOrderShowType reading_order_show_type, bool is_show_table_figure, bool is_display_like_element, bool is_show_table_cells)
 Set value. More...
 

Properties

bool is_display_like_element [get, set]
 Whether to display like elements in a single box.
 
bool is_show_table_cells [get, set]
 Whether to show table cells.
 
bool is_show_table_figure [get, set]
 Whether to show table and figure.
 
ReadingOrderOptions.ReadingOrderShowType reading_order_show_type [get, set]
 The type of reading order. Please refer to values starting from foxit.addon.accessibility.ReadingOrderOptions.ReadingOrderShowType.e_ReadingOrderShowTypeOrder and this should be one of these values.
 

Detailed Description

This class represents data used for reading order options.

Member Enumeration Documentation

◆ ReadingOrderShowType

Enumeration for reading order show type.

Values of this enumeration should be used alone.

Enumerator
e_ReadingOrderShowTypeOrder 

Show type: order.

e_ReadingOrderShowTypeStruct 

Show type: struct.

e_ReadingOrderShowTypeNone 

Show type: none.

Constructor & Destructor Documentation

◆ ReadingOrderOptions()

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

Constructor, with another reading order options object.

Parameters
[in]otherAnother reading order options object.

Member Function Documentation

◆ Set()

void foxit.addon.accessibility.ReadingOrderOptions.Set ( ReadingOrderOptions.ReadingOrderShowType  reading_order_show_type,
bool  is_show_table_figure,
bool  is_display_like_element,
bool  is_show_table_cells 
)
inline

Set value.

Parameters
[in]reading_order_show_typeThe reading order show type. Please refer to values starting from foxit.addon.accessibility.ReadingOrderOptions.ReadingOrderShowType.e_ReadingOrderShowTypeOrder and this should be one of these values.
[in]is_show_table_figureWhether to show table and figure.
[in]is_display_like_elementWhether to display like elements in a single box.
[in]is_show_table_cellsWhether to show table cells.
Returns
None.