Foxit PDF SDK
fsdk.TableData Class Reference

Public Member Functions

def GetCol_count ()
 Get the count of columns in the table. More...
 
def GetCol_width_array ()
 Get the column width array. More...
 
def GetInside_border_col ()
 Get the column inside border info. More...
 
def GetInside_border_row ()
 Get the row inside border info. More...
 
def GetMerge_cells ()
 Get the merge cells. More...
 
def GetOutside_border_bottom ()
 Get the bottom outside border info. More...
 
def GetOutside_border_left ()
 Get the left outside border info. More...
 
def GetOutside_border_right ()
 Get the right outside border info. More...
 
def GetOutside_border_top ()
 Get the top outside border info. More...
 
def GetRect ()
 Get rectangle of the table which specifies the position in PDF page. More...
 
def GetRow_count ()
 Get the count of rows in the table. More...
 
def GetRow_height_array ()
 Get the row height array. More...
 
def Set (rect, row_count, col_count, outside_border_left, outside_border_right, outside_border_top, outside_border_bottom, inside_border_row, inside_border_col, merge_cells, row_height_array, col_width_array)
 Set value.
More...
 
def SetCol_count (value)
 Set the count of columns in the table. More...
 
def SetCol_width_array (value)
 Set the column width array. More...
 
def SetInside_border_col (value)
 Set the column inside border info. More...
 
def SetInside_border_row (value)
 Set the row inside border info. More...
 
def SetMerge_cells (value)
 Set the merge cells. More...
 
def SetOutside_border_bottom (value)
 Set the bottom outside border info. More...
 
def SetOutside_border_left (value)
 Set the left outside border info. More...
 
def SetOutside_border_right (value)
 Set the right outside border info. More...
 
def SetOutside_border_top (value)
 Set the top outside border info. More...
 
def SetRect (value)
 Set rectangle of the table which specifies the position in PDF page. More...
 
def SetRow_count (value)
 Set the count of rows in the table. More...
 
def SetRow_height_array (value)
 Set the row height array. More...
 

Detailed Description

This class represents table data.

Member Function Documentation

◆ GetCol_count()

fsdk.TableData.GetCol_count ( )

Get the count of columns in the table.

Returns
The count of columns in the table.

◆ GetCol_width_array()

fsdk.TableData.GetCol_width_array ( )

Get the column width array.

Returns
The column width array. The column width will be set as default value automatically if the member of array is zero. Default: (width of rect)/col_count.

◆ GetInside_border_col()

fsdk.TableData.GetInside_border_col ( )

Get the column inside border info.

Returns
The column inside border info.

◆ GetInside_border_row()

fsdk.TableData.GetInside_border_row ( )

Get the row inside border info.

Returns
The row inside border info.

◆ GetMerge_cells()

fsdk.TableData.GetMerge_cells ( )

Get the merge cells.

Note
In a merged cell index array, every two consecutive members are grouped into cells. The first member represents the starting cell of the merged cell, and the second member represents the ending cell of the merged cell. For the table cell index, the valid range: from 0 to (row_count - 1) or (col_count - 1).
Returns
The merge cells. The length of this array must be even and the zero length means no merge cell.

◆ GetOutside_border_bottom()

fsdk.TableData.GetOutside_border_bottom ( )

Get the bottom outside border info.

Returns
The bottom outside border info.

◆ GetOutside_border_left()

fsdk.TableData.GetOutside_border_left ( )

Get the left outside border info.

Returns
The left outside border info.

◆ GetOutside_border_right()

fsdk.TableData.GetOutside_border_right ( )

Get the right outside border info.

Returns
The right outside border info.

◆ GetOutside_border_top()

fsdk.TableData.GetOutside_border_top ( )

Get the top outside border info.

Returns
The top outside border info.

◆ GetRect()

fsdk.TableData.GetRect ( )

Get rectangle of the table which specifies the position in PDF page.

Returns
Rectangle of the table which specifies the position in PDF page. It should be in [PDF coordinate system] ().

◆ GetRow_count()

fsdk.TableData.GetRow_count ( )

Get the count of rows in the table.

Returns
The count of rows in the table.

◆ GetRow_height_array()

fsdk.TableData.GetRow_height_array ( )

Get the row height array.

Returns
The row height array. The row height will be set as default value automatically if the member of array is zero. Default: (height of rect)/row_count.

◆ Set()

def fsdk.TableData.Set (   rect,
  row_count,
  col_count,
  outside_border_left,
  outside_border_right,
  outside_border_top,
  outside_border_bottom,
  inside_border_row,
  inside_border_col,
  merge_cells,
  row_height_array,
  col_width_array 
)

Set value.

Parameters
[in]rectThe rectangle of the table which specifies the position in PDF page.
[in]row_countThe count of rows in the table.
[in]col_countThe count of columns in the table.
[in]outside_border_leftThe left outside border info.
[in]outside_border_rightThe right outside border info.
[in]outside_border_topThe top outside border info.
[in]outside_border_bottomThe bottom outside border info.
[in]inside_border_rowThe row inside border info.
[in]inside_border_colThe column inside border info.
[in]merge_cellsThe merge cells.
[in]row_height_arrayThe row height array. The row height will be set as default value automatically if the member of array is zero. Default: (height of rect)/row_count.
[in]col_width_arrayThe column width array. The column width will be set as default value automatically if the member of array is zero. Default: (width of rect)/col_count.
Returns
None.

◆ SetCol_count()

fsdk.TableData.SetCol_count (   value)

Set the count of columns in the table.

Parameters
[in]valueThe count of columns in the table.
Returns
None.

◆ SetCol_width_array()

fsdk.TableData.SetCol_width_array (   value)

Set the column width array.

Parameters
[in]valueThe column width array. The column width will be set as default value automatically if the member of array is zero. Default: (width of rect)/col_count.
Returns
None.

◆ SetInside_border_col()

fsdk.TableData.SetInside_border_col (   value)

Set the column inside border info.

Parameters
[in]valueThe column inside border info.
Returns
None.

◆ SetInside_border_row()

fsdk.TableData.SetInside_border_row (   value)

Set the row inside border info.

Parameters
[in]valueThe row inside border info.
Returns
None.

◆ SetMerge_cells()

fsdk.TableData.SetMerge_cells (   value)

Set the merge cells.

Note
In a merged cell index array, every two consecutive members are grouped into cells. The first member represents the starting cell of the merged cell, and the second member represents the ending cell of the merged cell. For the table cell index, the valid range: from 0 to (row_count - 1) or (col_count - 1).
Parameters
[in]valueThe merge cells. The length of this array must be even and the zero length means no merge cell.
Returns
None.

◆ SetOutside_border_bottom()

fsdk.TableData.SetOutside_border_bottom (   value)

Set the bottom outside border info.

Parameters
[in]valueThe bottom outside border info.
Returns
None.

◆ SetOutside_border_left()

fsdk.TableData.SetOutside_border_left (   value)

Set the left outside border info.

Parameters
[in]valueThe left outside border info.
Returns
None.

◆ SetOutside_border_right()

fsdk.TableData.SetOutside_border_right (   value)

Set the right outside border info.

Parameters
[in]valueThe right outside border info.
Returns
None.

◆ SetOutside_border_top()

fsdk.TableData.SetOutside_border_top (   value)

Set the top outside border info.

Parameters
[in]valueThe top outside border info.
Returns
None.

◆ SetRect()

fsdk.TableData.SetRect (   value)

Set rectangle of the table which specifies the position in PDF page.

Parameters
[in]valueRectangle of the table which specifies the position in PDF page. It should be in [PDF coordinate system] ().
Returns
None.

◆ SetRow_count()

fsdk.TableData.SetRow_count (   value)

Set the count of rows in the table.

Parameters
[in]valueThe count of rows in the table.
Returns
None.

◆ SetRow_height_array()

fsdk.TableData.SetRow_height_array (   value)

Set the row height array.

Parameters
[in]valueThe row height array. The row height will be set as default value automatically if the member of array is zero. Default: (height of rect)/row_count.
Returns
None.