Foxit PDF SDK
fsdk.ContentTreeItemData Class Reference

Public Member Functions

def GetId ()
 Get the item ID. More...
 
def GetName ()
 Get the item name. More...
 
def GetPage_index ()
 Get the page index. More...
 
def GetRect_array ()
 Get the item rectangle array. More...
 
def Set (name, id, rect_array, page_index, type)
 Set value.
More...
 
def SetId (value)
 Set the item ID. More...
 
def SetName (value)
 Set the item name. More...
 
def SetPage_index (value)
 Set the page index. More...
 
def SetRect_array (value)
 Set the item rectangle array. More...
 

Detailed Description

This class represents content tree item data.

Member Function Documentation

◆ GetId()

fsdk.ContentTreeItemData.GetId ( )

Get the item ID.

Returns
The item ID.

◆ GetName()

fsdk.ContentTreeItemData.GetName ( )

Get the item name.

Returns
The item name.

◆ GetPage_index()

fsdk.ContentTreeItemData.GetPage_index ( )

Get the page index.

Returns
The page index. Valid range: from 0 to (count-1). count is returned by function fsdk.PDFDoc.GetPageCount .

◆ GetRect_array()

fsdk.ContentTreeItemData.GetRect_array ( )

Get the item rectangle array.

Returns
The item rectangle array.

◆ Set()

def fsdk.ContentTreeItemData.Set (   name,
  id,
  rect_array,
  page_index,
  type 
)

Set value.

Parameters
[in]nameThe item name.
[in]idThe item ID.
[in]rect_arrayThe item rectangle array.
[in]page_indexThe page index. Valid range: from 0 to (count-1). count is returned by function fsdk.PDFDoc.GetPageCount .
[in]typeThe content type. Please refer to values starting from fsdk.E_ContentTypeUnknown and this should be one of these values.
Returns
None.

◆ SetId()

fsdk.ContentTreeItemData.SetId (   value)

Set the item ID.

Parameters
[in]valueThe item ID.
Returns
None.

◆ SetName()

fsdk.ContentTreeItemData.SetName (   value)

Set the item name.

Parameters
[in]valueThe item name.
Returns
None.

◆ SetPage_index()

fsdk.ContentTreeItemData.SetPage_index (   value)

Set the page index.

Parameters
[in]valueThe page index. Valid range: from 0 to (count-1). count is returned by function fsdk.PDFDoc.GetPageCount .
Returns
None.

◆ SetRect_array()

fsdk.ContentTreeItemData.SetRect_array (   value)

Set the item rectangle array.

Parameters
[in]valueThe item rectangle array.
Returns
None.