fsdk.TagTreeItemData Class Reference

Public Member Functions
def	GetItem_id ()
	Get the unique identifier of the tag tree item. More...
def	GetItem_image_type ()
	Get the image type used to represent this tag tree item. More...
def	GetItem_name ()
	Get the display name of the tag tree item. More...
def	GetItem_node_type ()
	Get the node type of this tag tree item. More...
def	GetItem_pos ()
	Get the position descriptor of the tag tree item. More...
def	GetItem_rects ()
	Get the rectangles associated with this tag tree item. More...
def	GetPage_index ()
	Get the page index where this tag tree item is located. More...
def	Set (item_name, item_id, item_pos, item_rects, page_index, item_image_type, item_node_type)
	Set value. More...
def	SetItem_id (value)
	Set the unique identifier of the tag tree item. More...
def	SetItem_image_type (value)
	Set the image type used to represent this tag tree item. More...
def	SetItem_name (value)
	Set the display name of the tag tree item. More...
def	SetItem_node_type (value)
	Set the node type of this tag tree item. More...
def	SetItem_pos (value)
	Set the position descriptor of the tag tree item. More...
def	SetItem_rects (value)
	Set the rectangles associated with this tag tree item. More...
def	SetPage_index (value)
	Set the page index where this tag tree item is located. More...

Detailed Description

This class represents accessibility tag tree item data.

Member Function Documentation

GetItem_id()

fsdk.TagTreeItemData.GetItem_id

(

)

Get the unique identifier of the tag tree item.

Returns

The unique identifier of the tag tree item.

GetItem_image_type()

fsdk.TagTreeItemData.GetItem_image_type

(

)

Get the image type used to represent this tag tree item.

Returns

The image type used to represent this tag tree item. Please refer to values starting from fsdk.TagTreeItemDataE_TagImageTypePDF .

GetItem_name()

fsdk.TagTreeItemData.GetItem_name

(

)

Get the display name of the tag tree item.

Returns

The display name of the tag tree item.

GetItem_node_type()

fsdk.TagTreeItemData.GetItem_node_type

(

)

Get the node type of this tag tree item.

Returns

The node type of this tag tree item. Please refer to values starting from fsdk.TagTreeItemDataE_TagNodeTypeElement .

GetItem_pos()

fsdk.TagTreeItemData.GetItem_pos

(

)

Get the position descriptor of the tag tree item.

Returns

The position descriptor of the tag tree item.

GetItem_rects()

fsdk.TagTreeItemData.GetItem_rects

(

)

Get the rectangles associated with this tag tree item.

Returns

The rectangles associated with this tag tree item.

GetPage_index()

fsdk.TagTreeItemData.GetPage_index

(

)

Get the page index where this tag tree item is located.

Returns

The page index where this tag tree item is located. Valid range: from 0 to (count-1), where count is returned by function fsdk.PDFDoc.GetPageCount .

Set()

def fsdk.TagTreeItemData.Set	(		item_name,
			item_id,
			item_pos,
			item_rects,
			page_index,
			item_image_type,
			item_node_type
	)

Set value.

Parameters

[in]	item_name	The display name of the tag tree item.
[in]	item_id	The unique identifier of the tag tree item.
[in]	item_pos	The position descriptor of the tag tree item.
[in]	item_rects	The rectangles associated with this tag tree item.
[in]	page_index	The page index where this tag tree item is located. Valid range: from 0 to (count-1). count is returned by function fsdk.PDFDoc.GetPageCount .
[in]	item_image_type	The image type used to represent this tag tree item.
[in]	item_node_type	The node type of this tag tree item.

Returns

None.

SetItem_id()

fsdk.TagTreeItemData.SetItem_id

(

value

)

Set the unique identifier of the tag tree item.

Parameters

[in]

value

The unique identifier of the tag tree item.

Returns

None.

SetItem_image_type()

fsdk.TagTreeItemData.SetItem_image_type

(

value

)

Set the image type used to represent this tag tree item.

Parameters

[in]

value

The image type used to represent this tag tree item. Please refer to values starting from fsdk.TagTreeItemDataE_TagImageTypePDF .

Returns

None.

SetItem_name()

fsdk.TagTreeItemData.SetItem_name

(

value

)

Set the display name of the tag tree item.

Parameters

[in]

value

The display name of the tag tree item.

Returns

None.

SetItem_node_type()

fsdk.TagTreeItemData.SetItem_node_type

(

value

)

Set the node type of this tag tree item.

Parameters

[in]

value

The node type of this tag tree item. Please refer to values starting from fsdk.TagTreeItemDataE_TagNodeTypeElement .

Returns

None.

SetItem_pos()

fsdk.TagTreeItemData.SetItem_pos

(

value

)

Set the position descriptor of the tag tree item.

Parameters

[in]

value

The position descriptor of the tag tree item.

Returns

None.

SetItem_rects()

fsdk.TagTreeItemData.SetItem_rects

(

value

)

Set the rectangles associated with this tag tree item.

Parameters

[in]

value

The rectangles associated with this tag tree item.

Returns

None.

SetPage_index()

fsdk.TagTreeItemData.SetPage_index

(

value

)

Set the page index where this tag tree item is located.

Parameters

[in]

value

The page index where this tag tree item is located. Valid range: from 0 to (count-1), where count is returned by function fsdk.PDFDoc.GetPageCount .

Returns

None.