Foxit PDF SDK
fsdk.ReadingOrderOptions Class Reference

Public Member Functions

def GetIs_display_like_element ()
 Get whether to display like elements in a single box. More...
 
def GetIs_show_table_cells ()
 Get whether to show table cells. More...
 
def GetIs_show_table_figure ()
 Get whether to show table and figure. More...
 
def GetReading_order_show_type ()
 Get the type of reading order. More...
 
def Set (reading_order_show_type, is_show_table_figure, is_display_like_element, is_show_table_cells)
 Set value. More...
 
def SetIs_display_like_element (value)
 Set whether to display like elements in a single box. More...
 
def SetIs_show_table_cells (value)
 Set whether to show table cells. More...
 
def SetIs_show_table_figure (value)
 Set whether to show table and figure. More...
 
def SetReading_order_show_type (value)
 Set the type of reading order. More...
 

Detailed Description

This class represents data used for reading order options.

Member Function Documentation

◆ GetIs_display_like_element()

fsdk.ReadingOrderOptions.GetIs_display_like_element ( )

Get whether to display like elements in a single box.

Returns
Whether to display like elements in a single box.

◆ GetIs_show_table_cells()

fsdk.ReadingOrderOptions.GetIs_show_table_cells ( )

Get whether to show table cells.

Returns
Whether to show table cells.

◆ GetIs_show_table_figure()

fsdk.ReadingOrderOptions.GetIs_show_table_figure ( )

Get whether to show table and figure.

Returns
Whether to show table and figure.

◆ GetReading_order_show_type()

fsdk.ReadingOrderOptions.GetReading_order_show_type ( )

Get the type of reading order.

Returns
The type of reading order. Please refer to values starting from fsdk.ReadingOrderOptionsE_ReadingOrderShowTypeOrder and this should be one of these values.

◆ Set()

def fsdk.ReadingOrderOptions.Set (   reading_order_show_type,
  is_show_table_figure,
  is_display_like_element,
  is_show_table_cells 
)

Set value.

Parameters
[in]reading_order_show_typeThe reading order show type. Please refer to values starting from fsdk.ReadingOrderOptionsE_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.

◆ SetIs_display_like_element()

fsdk.ReadingOrderOptions.SetIs_display_like_element (   value)

Set whether to display like elements in a single box.

Parameters
[in]valueWhether to display like elements in a single box.
Returns
None.

◆ SetIs_show_table_cells()

fsdk.ReadingOrderOptions.SetIs_show_table_cells (   value)

Set whether to show table cells.

Parameters
[in]valueWhether to show table cells.
Returns
None.

◆ SetIs_show_table_figure()

fsdk.ReadingOrderOptions.SetIs_show_table_figure (   value)

Set whether to show table and figure.

Parameters
[in]valueWhether to show table and figure.
Returns
None.

◆ SetReading_order_show_type()

fsdk.ReadingOrderOptions.SetReading_order_show_type (   value)

Set the type of reading order.

Parameters
[in]valueThe type of reading order. Please refer to values starting from fsdk.ReadingOrderOptionsE_ReadingOrderShowTypeOrder and this should be one of these values.
Returns
None.