Inheritance diagram for foxit.addon.accessibility.ReadingOrder:

Public Types
enum	StructureType { StructureType.e_StructureTypeText = 0, StructureType.e_StructureTypeFigure = 1, StructureType.e_StructureTypeFormfield = 2, StructureType.e_StructureTypeFigureOrCaption = 3, StructureType.e_StructureTypeCaption = 4, StructureType.e_StructureTypeH1 = 5, StructureType.e_StructureTypeH2 = 6, StructureType.e_StructureTypeH3 = 7, StructureType.e_StructureTypeH4 = 8, StructureType.e_StructureTypeH5 = 9, StructureType.e_StructureTypeH6 = 10, StructureType.e_StructureTypeTable = 11, StructureType.e_StructureTypeCell = 12, StructureType.e_StructureTypeFormula = 13, StructureType.e_StructureTypeReference = 14, StructureType.e_StructureTypeNote = 15, StructureType.e_StructureTypeBackgroundOrArtifact = 16 }
	Enumeration for structure type of reading order. More...

enum	TableSelectResult { TableSelectResult.e_TableSelectResultNone = 0, TableSelectResult.e_TableSelectResultNotStarted = 1, TableSelectResult.e_TableSelectResultNotSamePage = 2, TableSelectResult.e_TableSelectResultNoTableExist = 3, TableSelectResult.e_TableSelectResultNotInTable = 4 }
	Enumeration for table select result. More...

Public Member Functions
	ReadingOrder (PDFDoc pdf_doc)
	Constructor. More...

	ReadingOrder (ReadingOrder other)
	Constructor, with another reading order object. More...

RectFArray	AddOrderDataForRect (int page_index, RectF rect)
	Add order data for selected rect. More...

bool	ApplyReadingOrder (int page_index, RectFArray selected_rect)
	Apply reading order to the specified page based on the given selected rectangle area(s). More...

bool	CanMoveDataOrder (int page_index, TreeItemInfoArray select_info_array, TreeItemInfo dest_move_item)
	Check whether data order can be moved. More...

ReadingOrder.TableSelectResult	CanSelectTableCellAtPoint (PDFPage page, PointF point)
	Check whether a table cell can be selected on mouse down at the given point. More...

void	ClearPageStructInfo (PDFPage page)
	Clear page structure info. More...

int	DeleteOrderDataStructInfo (PDFPage page, Int32Array src_order_index_array, bool is_loaded)
	Delete order data structure info. More...

bool	DrawReadingOrderItems (int page_index)
	Draw reading order items for a specified page. More...

bool	EndEditTable ()
	End edit table. More...

bool	GenerateTableHeaderIDs ()
	Generate table header IDs. More...

StringArray	GetAllLeafChildrenByContentItemID (ContentTreeItemArray content_tree, string content_item_id)
	Get all leaf children by content item ID. More...

ContentTreeItemArray	GetContentTree ()
	Get content tree. More...

WStringArray	GetCurrentTableHeaderIDs ()
	Get the array header ID of current table. More...

TreeItemArray	GetReadingOrderTreeItems ()
	Get reading order tree items. More...

TableCellAttributeArray	GetSelectedTableCellAttributes ()
	Get selected table cell attributes. More...

string	GetTableSummary (PDFPage page)
	Get table summary. More...

bool	HasHeaderID (string header_id)
	Check whether current table header ID is existing. More...

bool	HasMissingHeaderIDs ()
	Check whether current table is missing header IDs. More...

bool	IsEditingTable ()
	Check whether table editing has started. More...

bool	IsEmpty ()
	Check whether current object is empty or not. More...

int	MoveOrderData (int page_index, Int32Array src_order_index_array, int dest_order_index)
	Move data order. More...

RectFArray	RemoveOrderDataForRect (int page_index, RectF rect)
	Remove order data for selected rect. More...

bool	SelectTableAtPoint (int page_index, PointF point)
	Select the table at the specified point on a page, if any. More...

ReadingOrder.TableSelectResult	SelectTableCellAtPoint (PDFPage page, PointF point, RectFArray region_selected, bool appended)
	Select table cell by point on mouse up. More...

ReadingOrder.TableSelectResult	SelectTableCellAtRect (PDFPage page, RectF rect, RectFArray region_selected, bool appended)
	Select table cell by rect on mouse up. More...

bool	SetOrderTypeForSelectedContent (ReadingOrder.StructureType structure_type)
	Set order type for selected content. More...

bool	SetOrderTypeForSelectedTreeItems (ReadingOrder.StructureType structure_type, TreeItemInfoArray select_info_array)
	Set order type for selected tree items. More...

void	SetReadingOrderOptions (ReadingOrderOptions options)
	Set reading order options. More...

bool	SetSelectedTableCellAttributes (TableCellAttribute cell_attribute, bool change_id_enabled, bool need_change_ids)
	Set selected table cell attributes. More...

bool	SetTableSummary (PDFPage page, string table_summary)
	Set table summary. More...

bool	StartEditTable (PDFPage page)
	Start edit table. More...

bool	StartEditTableAtPoint (PDFPage page, PointF point)
	Start editing the table located at the specified point on a page, if any. More...

void	SynchronizeTable ()
	Synchronize table. More...

Detailed Description

This class represents a reading order for PDF document accessibility reading order operations. Before using any class or methods in this module, please ensure Foxit PDF SDK has been initialized successfully by function common.Library.Initialize with a key including "Accessibility" module.

See also: foxit.common.Library

Member Enumeration Documentation

◆ StructureType

enum foxit.addon.accessibility.ReadingOrder.StructureType

strong

Enumeration for structure type of reading order.

Values of this enumeration should be used alone.

Enumerator
e_StructureTypeText	Structure type: text.
e_StructureTypeFigure	Structure type: figure.
e_StructureTypeFormfield	Structure type: form field.
e_StructureTypeFigureOrCaption	Structure type: figure or caption.
e_StructureTypeCaption	Structure type: caption.
e_StructureTypeH1	Structure type: H1.
e_StructureTypeH2	Structure type: H2.
e_StructureTypeH3	Structure type: H3.
e_StructureTypeH4	Structure type: H4.
e_StructureTypeH5	Structure type: H5.
e_StructureTypeH6	Structure type: H6.
e_StructureTypeTable	Structure type: table.
e_StructureTypeCell	Structure type: cell.
e_StructureTypeFormula	Structure type: formula.
e_StructureTypeReference	Structure type: reference.
e_StructureTypeNote	Structure type: note.
e_StructureTypeBackgroundOrArtifact	Structure type: background or artifact.

◆ TableSelectResult

enum foxit.addon.accessibility.ReadingOrder.TableSelectResult

strong

Enumeration for table select result.

Values of this enumeration should be used alone.

Enumerator
e_TableSelectResultNone	Table select result : none.
e_TableSelectResultNotStarted	Table select result : not started.
e_TableSelectResultNotSamePage	Table select result : not same page.
e_TableSelectResultNoTableExist	Table select result : no table exist.
e_TableSelectResultNotInTable	Table select result : not in table.

Constructor & Destructor Documentation

◆ ReadingOrder() [1/2]

foxit.addon.accessibility.ReadingOrder.ReadingOrder ( PDFDoc pdf_doc )

inline

Constructor.

Parameters

[in] pdf_doc A valid PDF document object.

◆ ReadingOrder() [2/2]

foxit.addon.accessibility.ReadingOrder.ReadingOrder ( ReadingOrder other )

inline

Constructor, with another reading order object.

Parameters

[in] other Another reading order object.

Member Function Documentation

◆ AddOrderDataForRect()

RectFArray foxit.addon.accessibility.ReadingOrder.AddOrderDataForRect	(	int	page_index,
		RectF	rect
	)

inline

Add order data for selected rect.

Parameters

[in]	page_index	The page index. Valid range: from 0 to (count-1). count is returned by function pdf.PDFDoc.GetPageCount .
[in]	rect	The selected rect.

Returns: The updated order rect array.

◆ ApplyReadingOrder()

bool foxit.addon.accessibility.ReadingOrder.ApplyReadingOrder	(	int	page_index,
		RectFArray	selected_rect
	)

inline

Apply reading order to the specified page based on the given selected rectangle area(s).

Parameters

[in]	page_index	The page index. Valid range: from 0 to (count-1). count is returned by function pdf.PDFDoc.GetPageCount .
[in]	selected_rect	The array of selected rects which define the area(s) to be used for applying reading order.

Returns: true means success, while false means not.

◆ CanMoveDataOrder()

bool foxit.addon.accessibility.ReadingOrder.CanMoveDataOrder	(	int	page_index,
		TreeItemInfoArray	select_info_array,
		TreeItemInfo	dest_move_item
	)

inline

Check whether data order can be moved.

Parameters

[in]	page_index	The page index. Valid range: from 0 to (count-1). count is returned by function pdf.PDFDoc.GetPageCount .
[in]	select_info_array	The selected info array.
[in]	dest_move_item	The destination move item.

Returns: true means data order can be moved, while false means not.

◆ CanSelectTableCellAtPoint()

ReadingOrder.TableSelectResult foxit.addon.accessibility.ReadingOrder.CanSelectTableCellAtPoint	(	PDFPage	page,
		PointF	point
	)

inline

Check whether a table cell can be selected on mouse down at the given point.

Parameters

[in]	page	A PDF page object.
[in]	point	The point, in the PDF coordinate system (PDFPage).

Returns: The table select result. Please refer to values starting from foxit.addon.accessibility.ReadingOrder.TableSelectResult.e_TableSelectResultNone .

◆ ClearPageStructInfo()

void foxit.addon.accessibility.ReadingOrder.ClearPageStructInfo ( PDFPage page )

inline

Clear page structure info.

Parameters

[in] page The PDF page object.

Returns: None.

◆ DeleteOrderDataStructInfo()

int foxit.addon.accessibility.ReadingOrder.DeleteOrderDataStructInfo	(	PDFPage	page,
		Int32Array	src_order_index_array,
		bool	is_loaded
	)

inline

Delete order data structure info.

Parameters

[in]	page	The PDF page object.
[in]	src_order_index_array	The source order index array.
[in]	is_loaded	Whether the page is loaded.

Returns: The deleted count.

◆ DrawReadingOrderItems()

bool foxit.addon.accessibility.ReadingOrder.DrawReadingOrderItems ( int page_index )

inline

Draw reading order items for a specified page.

Parameters

[in] page_index The page index. Valid range: from 0 to (count-1). count is returned by function pdf.PDFDoc.GetPageCount .

Returns: true means success, while false means not.

◆ EndEditTable()

bool foxit.addon.accessibility.ReadingOrder.EndEditTable ( )

inline

End edit table.

Returns: true means success, while false means not.

◆ GenerateTableHeaderIDs()

bool foxit.addon.accessibility.ReadingOrder.GenerateTableHeaderIDs ( )

inline

Generate table header IDs.

Returns: true means success, while false means not.

◆ GetAllLeafChildrenByContentItemID()

StringArray foxit.addon.accessibility.ReadingOrder.GetAllLeafChildrenByContentItemID	(	ContentTreeItemArray	content_tree,
		string	content_item_id
	)

inline

Get all leaf children by content item ID.

Parameters

[in]	content_tree	The content tree.
[in]	content_item_id	The content item ID.

Returns: The array of leaf children IDs.

◆ GetContentTree()

ContentTreeItemArray foxit.addon.accessibility.ReadingOrder.GetContentTree ( )

inline

Get content tree.

Returns: The array of content tree items.

◆ GetCurrentTableHeaderIDs()

WStringArray foxit.addon.accessibility.ReadingOrder.GetCurrentTableHeaderIDs ( )

inline

Get the array header ID of current table.

Returns: The array of header ID.

◆ GetReadingOrderTreeItems()

TreeItemArray foxit.addon.accessibility.ReadingOrder.GetReadingOrderTreeItems ( )

inline

Get reading order tree items.

Returns: The array of reading order tree items.

◆ GetSelectedTableCellAttributes()

TableCellAttributeArray foxit.addon.accessibility.ReadingOrder.GetSelectedTableCellAttributes ( )

inline

Get selected table cell attributes.

Returns: The array of cell attribute objects.

◆ GetTableSummary()

string foxit.addon.accessibility.ReadingOrder.GetTableSummary ( PDFPage page )

inline

Get table summary.

Parameters

[in] page The PDF page object.

Returns: The table summary text.

◆ HasHeaderID()

bool foxit.addon.accessibility.ReadingOrder.HasHeaderID ( string header_id )

inline

Check whether current table header ID is existing.

Parameters

[in] header_id The header ID to check.

Returns: true means the header ID is existing, while false means not.

◆ HasMissingHeaderIDs()

bool foxit.addon.accessibility.ReadingOrder.HasMissingHeaderIDs ( )

inline

Check whether current table is missing header IDs.

Returns: true means current table is missing header IDs, while false means not.

◆ IsEditingTable()

bool foxit.addon.accessibility.ReadingOrder.IsEditingTable ( )

inline

Check whether table editing has started.

Returns: true means table editing has started, while false means not.

◆ IsEmpty()

bool foxit.addon.accessibility.ReadingOrder.IsEmpty ( )

inline

Check whether current object is empty or not.

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

◆ MoveOrderData()

int foxit.addon.accessibility.ReadingOrder.MoveOrderData	(	int	page_index,
		Int32Array	src_order_index_array,
		int	dest_order_index
	)

inline

Move data order.

Parameters

[in]	page_index	The page index. Valid range: from 0 to (count-1). count is returned by function pdf.PDFDoc.GetPageCount .
[in]	src_order_index_array	The source order index array.
[in]	dest_order_index	The destination order index.

Returns: The moved count.

◆ RemoveOrderDataForRect()

RectFArray foxit.addon.accessibility.ReadingOrder.RemoveOrderDataForRect	(	int	page_index,
		RectF	rect
	)

inline

Remove order data for selected rect.

Parameters

[in]	page_index	The page index. Valid range: from 0 to (count-1). count is returned by function pdf.PDFDoc.GetPageCount .
[in]	rect	The selected rect.

Returns: The updated order rect array.

◆ SelectTableAtPoint()

bool foxit.addon.accessibility.ReadingOrder.SelectTableAtPoint	(	int	page_index,
		PointF	point
	)

inline

Select the table at the specified point on a page, if any.

Parameters

[in]	page_index	The page index. Valid range: from 0 to (count-1). count is returned by function pdf.PDFDoc.GetPageCount .
[in]	point	The point used to locate the table, in PDF page coordinate system.

Returns: true means a table is found and selected at the specified point, while false means not.

◆ SelectTableCellAtPoint()

ReadingOrder.TableSelectResult foxit.addon.accessibility.ReadingOrder.SelectTableCellAtPoint	(	PDFPage	page,
		PointF	point,
		RectFArray	region_selected,
		bool	appended
	)

inline

Select table cell by point on mouse up.

Parameters

[in]	page	A PDF page object.
[in]	point	The point.
[out]	region_selected	The selected region array.
[in]	appended	Whether to append the selection.

Returns: The table select result. Please refer to values starting from foxit.addon.accessibility.ReadingOrder.TableSelectResult.e_TableSelectResultNone .

◆ SelectTableCellAtRect()

ReadingOrder.TableSelectResult foxit.addon.accessibility.ReadingOrder.SelectTableCellAtRect	(	PDFPage	page,
		RectF	rect,
		RectFArray	region_selected,
		bool	appended
	)

inline

Select table cell by rect on mouse up.

Parameters

[in]	page	A PDF page object.
[in]	rect	The rectangular area .
[out]	region_selected	The selected region array.
[in]	appended	Whether to append the selection.

Returns: The table select result. Please refer to values starting from foxit.addon.accessibility.ReadingOrder.TableSelectResult.e_TableSelectResultNone .

◆ SetOrderTypeForSelectedContent()

bool foxit.addon.accessibility.ReadingOrder.SetOrderTypeForSelectedContent ( ReadingOrder.StructureType structure_type )

inline

Set order type for selected content.

Parameters

[in] structure_type The structure type. Please refer to values starting from and this should be one of these values.

Returns: true means success, while false means not.

◆ SetOrderTypeForSelectedTreeItems()

bool foxit.addon.accessibility.ReadingOrder.SetOrderTypeForSelectedTreeItems	(	ReadingOrder.StructureType	structure_type,
		TreeItemInfoArray	select_info_array
	)

inline

Set order type for selected tree items.

Parameters

[in]	structure_type	The structure type. Please refer value .
[in]	select_info_array	The selected info array.

Returns: true means success, while false means not.

◆ SetReadingOrderOptions()

void foxit.addon.accessibility.ReadingOrder.SetReadingOrderOptions ( ReadingOrderOptions options )

inline

Set reading order options.

Parameters

[in] options The reading order options. Please refer to ReadingOrderOptions .

Returns: None.

◆ SetSelectedTableCellAttributes()

bool foxit.addon.accessibility.ReadingOrder.SetSelectedTableCellAttributes	(	TableCellAttribute	cell_attribute,
		bool	change_id_enabled,
		bool	need_change_ids
	)

inline

Set selected table cell attributes.

Parameters

[in]	cell_attribute	The cell attribute to set.
[in]	change_id_enabled	Whether to enable changing Id.
[in]	need_change_ids	Whether to change IDs.

Returns: true means success, while false means not.

◆ SetTableSummary()

bool foxit.addon.accessibility.ReadingOrder.SetTableSummary	(	PDFPage	page,
		string	table_summary
	)

inline

Set table summary.

Parameters

[in]	page	The PDF page object.
[in]	table_summary	The table summary text.

Returns: true means success, while false means not.

◆ StartEditTable()

bool foxit.addon.accessibility.ReadingOrder.StartEditTable ( PDFPage page )

inline

Start edit table.

Parameters

[in] page The PDF page object.

Returns: true means success, while false means not.

◆ StartEditTableAtPoint()

bool foxit.addon.accessibility.ReadingOrder.StartEditTableAtPoint	(	PDFPage	page,
		PointF	point
	)

inline

Start editing the table located at the specified point on a page, if any.

Parameters

[in]	page	The PDF page object.
[in]	point	The point used to locate the table to be edited, in the PDF coordinate system (PDFPage).

Returns: true means a table is found at the specified point and editing has started successfully, while false means not.

◆ SynchronizeTable()

void foxit.addon.accessibility.ReadingOrder.SynchronizeTable ( )

inline

Synchronize table.

Returns: None.

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ StructureType

◆ TableSelectResult

Constructor & Destructor Documentation

◆ ReadingOrder() [1/2]

◆ ReadingOrder() [2/2]

Member Function Documentation

◆ AddOrderDataForRect()

◆ ApplyReadingOrder()

◆ CanMoveDataOrder()

◆ CanSelectTableCellAtPoint()

◆ ClearPageStructInfo()

◆ DeleteOrderDataStructInfo()

◆ DrawReadingOrderItems()

◆ EndEditTable()

◆ GenerateTableHeaderIDs()

◆ GetAllLeafChildrenByContentItemID()

◆ GetContentTree()

◆ GetCurrentTableHeaderIDs()

◆ GetReadingOrderTreeItems()

◆ GetSelectedTableCellAttributes()

◆ GetTableSummary()

◆ HasHeaderID()

◆ HasMissingHeaderIDs()

◆ IsEditingTable()

◆ IsEmpty()

◆ MoveOrderData()

◆ RemoveOrderDataForRect()

◆ SelectTableAtPoint()

◆ SelectTableCellAtPoint()

◆ SelectTableCellAtRect()

◆ SetOrderTypeForSelectedContent()

◆ SetOrderTypeForSelectedTreeItems()

◆ SetReadingOrderOptions()

◆ SetSelectedTableCellAttributes()

◆ SetTableSummary()

◆ StartEditTable()

◆ StartEditTableAtPoint()

◆ SynchronizeTable()