Foxit PDF SDK
FSTagTreeItemData Class Reference

Inherits NSObject.

Instance Methods

(id) - init
 Constructor.

 
(id) - initWithOther:
 Constructor, with another accessibility tag tree item data object.
More...
 
(void) - set:item_id:item_pos:item_rects:page_index:item_image_type:item_node_type:
 Set value.
More...
 

Properties

NSString * item_id
 The unique identifier of the tag tree item.

 
FSTagTreeItemDataTagImageType item_image_type
 The image type used to represent this tag tree item. Please refer to values starting from FSTagTreeItemDataTagImageTypePDF.

 
NSString * item_name
 The display name of the tag tree item.

 
FSTagTreeItemDataTagNodeType item_node_type
 The node type of this tag tree item. Please refer to values starting from FSTagTreeItemDataTagNodeTypeElement.

 
NSString * item_pos
 The position descriptor of the tag tree item.

 
FSRectFArray * item_rects
 The rectangles associated with this tag tree item.

 
int page_index
 The page index where this tag tree item is located. Valid range: from 0 to (count-1), where count is returned by function FSPDFDoc::getPageCount.

 

Detailed Description

This class represents accessibility tag tree item data.

Method Documentation

◆ initWithOther:()

- (id) initWithOther: (FSTagTreeItemData*)  other

Constructor, with another accessibility tag tree item data object.

Parameters
[in]otherAnother accessibility tag tree item data object whose values are copied to initialize the current object.

◆ set:item_id:item_pos:item_rects:page_index:item_image_type:item_node_type:()

- (void) set: (NSString *)  item_name
item_id: (NSString *)  item_id
item_pos: (NSString *)  item_pos
item_rects: (FSRectFArray*)  item_rects
page_index: (int)  page_index
item_image_type: (FSTagTreeItemDataTagImageType)  item_image_type
item_node_type: (FSTagTreeItemDataTagNodeType)  item_node_type 

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. Valid range: from 0 to (count-1). count is returned by function FSPDFDoc::getPageCount.
[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.