All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
pdftron::Layout::Table Class Reference

#include <ContentTree.h>

+ Inheritance diagram for pdftron::Layout::Table:

Public Member Functions

 ~Table ()
 
void Destroy ()
 
TableRow AddTableRow ()
 
TableCell GetTableCell (UInt32 column, UInt32 row)
 
void SetDefaultColumnWidth (double val)
 
double GetDefaultRowHeight ()
 
void SetDefaultRowHeight (double val)
 
void SetBorder (double thickness, UInt8 red, UInt8 green, UInt8 blue)
 
double GetBorderThickness ()
 
UInt32 GetNumRows ()
 
UInt32 GetNumColumns ()
 
- Public Member Functions inherited from pdftron::Layout::ContentNode
 ~ContentNode ()
 
void Destroy ()
 
ContentNodeIterator GetContentNodeIterator ()
 
- Public Member Functions inherited from pdftron::Layout::ContentElement
 ~ContentElement ()
 
void Destroy ()
 
ElementRef< ListAsList () const
 
ElementRef< ListItemAsListItem () const
 
ElementRef< ContentNodeAsContentNode () const
 
ElementRef< TextRunAsTextRun () const
 
ElementRef< ParagraphAsParagraph () const
 
ElementRef< TableAsTable () const
 
ElementRef< TableRowAsTableRow () const
 
ElementRef< TableCellAsTableCell () const
 
TextStyledElement GetTextStyledElement ()
 

Friends

class FlowDocument
 
class ElementRef< Table >
 
class TableCell
 

Additional Inherited Members

- Public Attributes inherited from pdftron::Layout::ContentElement
TRN_ContentElement m_impl
 
- Protected Member Functions inherited from pdftron::Layout::ContentNode
 ContentNode (TRN_ContentNode impl)
 
- Protected Member Functions inherited from pdftron::Layout::ContentElement
 ContentElement (TRN_ContentElement impl)
 

Detailed Description

A Table is a content node that contains a grid of cells.

Definition at line 785 of file ContentTree.h.

Constructor & Destructor Documentation

pdftron::Layout::Table::~Table ( )

Member Function Documentation

TableRow pdftron::Layout::Table::AddTableRow ( )

Add a new row to the table

Returns
The newly created row
void pdftron::Layout::Table::Destroy ( )
double pdftron::Layout::Table::GetBorderThickness ( )

Get the border thickness of the table

Returns
border thickness in points
double pdftron::Layout::Table::GetDefaultRowHeight ( )

Get default row height of the table

Returns
Default row height of the table
UInt32 pdftron::Layout::Table::GetNumColumns ( )

Get the number of rows in the table

Returns
number of rows in the table
UInt32 pdftron::Layout::Table::GetNumRows ( )

Get the number of rows in the table

Returns
number of rows in the table
TableCell pdftron::Layout::Table::GetTableCell ( UInt32  column,
UInt32  row 
)

Get a cell from the table

Parameters
columnThe column index of the cell to retrieve
rowThe row index of the cell to retrieve
Returns
the TableCell at the specified column and row
void pdftron::Layout::Table::SetBorder ( double  thickness,
UInt8  red,
UInt8  green,
UInt8  blue 
)

Set the cell's border thickness and color

Parameters
thicknessThe thickness of the border in points
redThe red component of the border color
greenThe green component of the border color
blueThe blue component of the border color
void pdftron::Layout::Table::SetDefaultColumnWidth ( double  val)

Set default column weight of the table

Parameters
valThe default column weight
void pdftron::Layout::Table::SetDefaultRowHeight ( double  val)

Set default row height of the table

Parameters
valThe default row height

Friends And Related Function Documentation

friend class ElementRef< Table >
friend

Definition at line 788 of file ContentTree.h.

friend class FlowDocument
friend

Definition at line 787 of file ContentTree.h.

friend class TableCell
friend

Definition at line 789 of file ContentTree.h.


The documentation for this class was generated from the following file: