Loading...
Searching...
No Matches
pdftron::Layout::TableCell Class Reference

#include <ContentTree.h>

Inheritance diagram for pdftron::Layout::TableCell:

Public Types

enum  CellAlignmentVertical { e_alignment_top = 1 , e_alignment_center = 2 , e_alignment_bottom = 3 }
enum  CellAlignmentHorizontal { e_alignment_left = 1 , e_alignment_middle = 2 , e_alignment_right = 3 }

Public Member Functions

 ~TableCell ()
void Destroy ()
Paragraph AddParagraph ()
Paragraph AddParagraph (const UString &text)
Table AddTable ()
TableCell MergeCellsRight (UInt32 num)
TableCell MergeCellsDown (UInt32 num)
void SetBackgroundColor (UInt8 red, UInt8 green, UInt8 blue)
void SetBorder (double thickness, UInt8 red, UInt8 green, UInt8 blue)
double GetBorderThickness ()
void SetVerticalAlignment (CellAlignmentVertical val)
CellAlignmentVertical GetVerticalAlignment ()
void SetHorizontalAlignment (CellAlignmentHorizontal val)
CellAlignmentHorizontal GetHorizontalAlignment ()
void SetHeight (double val)
double GetHeight ()
void SetWidth (double val)
double GetWidth ()
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 Table
class TableRow
class ElementRef< 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 class representing a table cell, which can be used during document creation.

Definition at line 575 of file ContentTree.h.

Member Enumeration Documentation

◆ CellAlignmentHorizontal

Enumerator
e_alignment_left 

Cell content is left-aligned

e_alignment_middle 

Cell content is horizontally centered

e_alignment_right 

Cell content is right-aligned

Definition at line 603 of file ContentTree.h.

◆ CellAlignmentVertical

Enumerator
e_alignment_top 

Cell content is top-aligned

e_alignment_center 

Cell content is vertically centered

e_alignment_bottom 

Cell content is bottom-aligned

Definition at line 587 of file ContentTree.h.

Constructor & Destructor Documentation

◆ ~TableCell()

pdftron::Layout::TableCell::~TableCell ( )

Member Function Documentation

◆ AddParagraph() [1/2]

Paragraph pdftron::Layout::TableCell::AddParagraph ( )

Add an empty paragraph to the cell

Returns
The paragraph that was added

◆ AddParagraph() [2/2]

Paragraph pdftron::Layout::TableCell::AddParagraph ( const UString & text)

Add a paragraph with text to the cell

Returns
The paragraph that was added

◆ AddTable()

Table pdftron::Layout::TableCell::AddTable ( )

Add a nested table to the cell

Returns
The table that was added

◆ Destroy()

void pdftron::Layout::TableCell::Destroy ( )

◆ GetBorderThickness()

double pdftron::Layout::TableCell::GetBorderThickness ( )

Get the border thickness of the table cell

Returns
border thickness

◆ GetHeight()

double pdftron::Layout::TableCell::GetHeight ( )

Get the height of the cell

Returns
the height of the cell

◆ GetHorizontalAlignment()

CellAlignmentHorizontal pdftron::Layout::TableCell::GetHorizontalAlignment ( )

Get the horizontal alignment of the cell

Returns
the horizontal Alignment of the cell

◆ GetVerticalAlignment()

CellAlignmentVertical pdftron::Layout::TableCell::GetVerticalAlignment ( )

Get the vertical alignment of the cell

Returns
the vertical alignment of the cell

◆ GetWidth()

double pdftron::Layout::TableCell::GetWidth ( )

Get the width of the cell

Returns
the width of the cell

◆ MergeCellsDown()

TableCell pdftron::Layout::TableCell::MergeCellsDown ( UInt32 num)

Merge the cell with the specified number of cells downwards

Returns
The merged cell

◆ MergeCellsRight()

TableCell pdftron::Layout::TableCell::MergeCellsRight ( UInt32 num)

Merge the cell with the specified number of cells to the right

Returns
The merged cell

◆ SetBackgroundColor()

void pdftron::Layout::TableCell::SetBackgroundColor ( UInt8 red,
UInt8 green,
UInt8 blue )

Set the background color of the cell

Parameters
redThe red component of the border color
greenThe green component of the border color
blueThe blue component of the border color

◆ SetBorder()

void pdftron::Layout::TableCell::SetBorder ( double thickness,
UInt8 red,
UInt8 green,
UInt8 blue )

Set the cell's border thickness and color

Parameters
thicknessThe thickness of the border
redThe red component of the border color
greenThe green component of the border color
blueThe blue component of the border color

◆ SetHeight()

void pdftron::Layout::TableCell::SetHeight ( double val)

Set the height of the cell

Parameters
valThe height of the cell

◆ SetHorizontalAlignment()

void pdftron::Layout::TableCell::SetHorizontalAlignment ( CellAlignmentHorizontal val)

Set horizontal alignment of the cell

Parameters
valThe horizontal alignment of the cell

◆ SetVerticalAlignment()

void pdftron::Layout::TableCell::SetVerticalAlignment ( CellAlignmentVertical val)

Set the vertical alignment of the cell

Parameters
valThe vertical alignment of the cell

◆ SetWidth()

void pdftron::Layout::TableCell::SetWidth ( double val)

Set the width of the cell

Parameters
valThe width of the cell

◆ ElementRef< TableCell >

friend class ElementRef< TableCell >
friend

Definition at line 578 of file ContentTree.h.

◆ Table

friend class Table
friend

Definition at line 577 of file ContentTree.h.

◆ TableRow

friend class TableRow
friend

Definition at line 578 of file ContentTree.h.


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