Foxit PDF SDK
fsdk.SelectItemInfo Class Reference

Public Member Functions

def GetOrder_index ()
 Get the order index of selected item. More...
 
def GetPage_index ()
 Get the page index of selected item. More...
 
def GetRect ()
 Get the rectangular coordinates of the selected item on the PDF page. More...
 
def Set (page_index, order_index, rect)
 Set value.
More...
 
def SetOrder_index (value)
 Set the order index of selected item. More...
 
def SetPage_index (value)
 Set the page index of selected item. More...
 
def SetRect (value)
 Set the rectangular coordinates of the selected item on the PDF page. More...
 

Detailed Description

This class represents data used for reading order select item info.

Member Function Documentation

◆ GetOrder_index()

fsdk.SelectItemInfo.GetOrder_index ( )

Get the order index of selected item.

Returns
The order index of selected item.

◆ GetPage_index()

fsdk.SelectItemInfo.GetPage_index ( )

Get the page index of selected item.

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

◆ GetRect()

fsdk.SelectItemInfo.GetRect ( )

Get the rectangular coordinates of the selected item on the PDF page.

Returns
The rectangular coordinates of the selected item on the PDF page.

◆ Set()

def fsdk.SelectItemInfo.Set (   page_index,
  order_index,
  rect 
)

Set value.

Parameters
[in]page_indexThe page index. Valid range: from 0 to (count-1). count is returned by function fsdk.PDFDoc.GetPageCount .
[in]order_indexThe order index.
[in]rectThe rectangular coordinates of the selected element object on the PDF page.
Returns
None.

◆ SetOrder_index()

fsdk.SelectItemInfo.SetOrder_index (   value)

Set the order index of selected item.

Parameters
[in]valueThe order index of selected item.
Returns
None.

◆ SetPage_index()

fsdk.SelectItemInfo.SetPage_index (   value)

Set the page index of selected item.

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

◆ SetRect()

fsdk.SelectItemInfo.SetRect (   value)

Set the rectangular coordinates of the selected item on the PDF page.

Parameters
[in]valueThe rectangular coordinates of the selected item on the PDF page.
Returns
None.