Foxit PDF SDK
FSDK.TagTreeItemData Class Reference

Public Member Functions

 constructor ()
 Constructor.
 
 constructor (item_name, item_id, item_pos, item_rects, page_index, item_image_type, item_node_type)
 Constructor, with parameters. More...
 
 Set (item_name, item_id, item_pos, item_rects, page_index, item_image_type, item_node_type)
 Set value. More...
 

Public Attributes

 item_id
 The unique identifier of the tag tree item.
 
 item_image_type
 The image type used to represent this tag tree item. Please refer to values starting from FSDK.TagTreeItemData.e_TagImageTypePDF.
 
 item_name
 The display name of the tag tree item.
 
 item_node_type
 The node type of this tag tree item. Please refer to values starting from FSDK.TagTreeItemData.e_TagNodeTypeElement.
 
 item_pos
 The position descriptor of the tag tree item.
 
 item_rects
 The rectangles associated with this tag tree item.
 
 page_index
 The page index where this tag tree item is located.
 

Static Public Attributes

static e_TagImageTypePageObject
 Tag image type : page object.
 
static e_TagImageTypePDF
 Enumeration for tag image type. More...
 
static e_TagImageTypeTable
 Tag image type : table.
 
static e_TagImageTypeTableDataCell
 Tag image type : table data cell.
 
static e_TagImageTypeTableHeaderCell
 Tag image type : table header cell.
 
static e_TagImageTypeTableRow
 Tag image type : table row.
 
static e_TagImageTypeTagNode
 Tag image type : tag node.
 
static e_TagImageTypeTagParagraph
 Tag image type : tag paragraph.
 
static e_TagImageTypeTagSection
 Tag image type : tag section.
 
static e_TagNodeTypeElement
 Enumeration for tag node type. More...
 
static e_TagNodeTypeMarkedContentSeq
 Tag node type : marked content sequence.
 
static e_TagNodeTypeObject
 Tag node type : object.
 

Detailed Description

This class represents accessibility tag tree item data.

Member Function Documentation

◆ constructor()

FSDK.TagTreeItemData.constructor (   item_name,
  item_id,
  item_pos,
  item_rects,
  page_index,
  item_image_type,
  item_node_type 
)
inline

Constructor, with parameters.

Parameters
[in]item_nameThe display name of the tag tree item.
[in]item_idThe unique identifier of the tag tree item.
[in]item_posThe position descriptor of the tag tree item.
[in]item_rectsThe rectangles associated with this tag tree item.
[in]page_indexThe page index where this tag tree item is located.
[in]item_image_typeThe image type used to represent this tag tree item.
[in]item_node_typeThe node type of this tag tree item.

◆ Set()

FSDK.TagTreeItemData.Set (   item_name,
  item_id,
  item_pos,
  item_rects,
  page_index,
  item_image_type,
  item_node_type 
)
inline

Set value.

Parameters
[in]item_nameThe display name of the tag tree item.
[in]item_idThe unique identifier of the tag tree item.
[in]item_posThe position descriptor of the tag tree item.
[in]item_rectsThe rectangles associated with this tag tree item.
[in]page_indexThe page index where this tag tree item is located.
[in]item_image_typeThe image type used to represent this tag tree item.
[in]item_node_typeThe node type of this tag tree item.
Returns
None.

Member Data Documentation

◆ e_TagImageTypePDF

FSDK.TagTreeItemData.e_TagImageTypePDF
static

Enumeration for tag image type.

Values of this enumeration should be used alone.

Tag image type : PDF.

◆ e_TagNodeTypeElement

FSDK.TagTreeItemData.e_TagNodeTypeElement
static

Enumeration for tag node type.

Values of this enumeration should be used alone.

Tag node type : element.