Foxit PDF SDK
foxit.addon.tablegenerator.TableData Class Reference

Inherits SystemIDisposable.

Public Member Functions

 TableData ()
 Constructor.
 
 TableData (RectF rect, int row_count, int col_count, TableBorderInfo outside_border_left, TableBorderInfo outside_border_right, TableBorderInfo outside_border_top, TableBorderInfo outside_border_bottom, TableBorderInfo inside_border_row, TableBorderInfo inside_border_col, TableCellIndexArray merge_cells, FloatArray row_height_array, FloatArray col_width_array)
 Constructor, with parameters. More...
 
 TableData (TableData data)
 Constructor, with another table cell data object. More...
 
void Set (RectF rect, int row_count, int col_count, TableBorderInfo outside_border_left, TableBorderInfo outside_border_right, TableBorderInfo outside_border_top, TableBorderInfo outside_border_bottom, TableBorderInfo inside_border_row, TableBorderInfo inside_border_col, TableCellIndexArray merge_cells, FloatArray row_height_array, FloatArray col_width_array)
 Set value. More...
 

Properties

int col_count [get, set]
 The count of columns in the table.
 
FloatArraycol_width_array [get, set]
 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.
 
TableBorderInfoinside_border_col [get, set]
 The column inside border info.
 
TableBorderInfoinside_border_row [get, set]
 The row inside border info.
 
TableCellIndexArraymerge_cells [get, set]
 The merge cells. The length of this array must be even and the zero length means no merge cell. More...
 
TableBorderInfooutside_border_bottom [get, set]
 The bottom outside border info.
 
TableBorderInfooutside_border_left [get, set]
 The left outside border info.
 
TableBorderInfooutside_border_right [get, set]
 The right outside border info.
 
TableBorderInfooutside_border_top [get, set]
 The top outside border info.
 
RectFrect [get, set]
 Rectangle of the table which specifies the position in PDF page. It should be in [PDF coordinate system] (foxit.pdf.PDFPage).
 
int row_count [get, set]
 The count of rows in the table.
 
FloatArrayrow_height_array [get, set]
 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.
 

Detailed Description

This class represents table data.

Constructor & Destructor Documentation

◆ TableData() [1/2]

foxit.addon.tablegenerator.TableData.TableData ( RectF  rect,
int  row_count,
int  col_count,
TableBorderInfo  outside_border_left,
TableBorderInfo  outside_border_right,
TableBorderInfo  outside_border_top,
TableBorderInfo  outside_border_bottom,
TableBorderInfo  inside_border_row,
TableBorderInfo  inside_border_col,
TableCellIndexArray  merge_cells,
FloatArray  row_height_array,
FloatArray  col_width_array 
)
inline

Constructor, with parameters.

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.

◆ TableData() [2/2]

foxit.addon.tablegenerator.TableData.TableData ( TableData  data)
inline

Constructor, with another table cell data object.

Parameters
[in]dataAnother table data object, whose value would be assigned to current object.

Member Function Documentation

◆ Set()

void foxit.addon.tablegenerator.TableData.Set ( RectF  rect,
int  row_count,
int  col_count,
TableBorderInfo  outside_border_left,
TableBorderInfo  outside_border_right,
TableBorderInfo  outside_border_top,
TableBorderInfo  outside_border_bottom,
TableBorderInfo  inside_border_row,
TableBorderInfo  inside_border_col,
TableCellIndexArray  merge_cells,
FloatArray  row_height_array,
FloatArray  col_width_array 
)
inline

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.

Property Documentation

◆ merge_cells

TableCellIndexArray foxit.addon.tablegenerator.TableData.merge_cells
getset

The merge cells. The length of this array must be even and the zero length means no merge cell.

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).