Foxit PDF SDK
foxit::addon::tablegenerator::TableCellDataColArray Class Reference

This class represents an array of TableCellData objects,inserted in the order of the displayed table from left to right. More...

Inherits Object.

Public Member Functions

 TableCellDataColArray ()
 Constructor.
 
 TableCellDataColArray (const TableCellDataColArray &other)
 Constructor, with another array object. More...
 
 ~ TableCellDataColArray ()
 Destructor.
 
void Add (const TableCellData &element)
 Add an element to the end of current array. More...
 
TableCellData GetAt (size_t index) const
 Retrieve a copy of the element at position specified by index in current array. More...
 
size_t GetSize () const
 Get the size of elements in current array. More...
 
void InsertAt (size_t index, const TableCellData &element)
 Insert an element before the position specified by index. More...
 
TableCellDataColArrayoperator= (const TableCellDataColArray &other)
 Assign operator. More...
 
TableCellDataoperator[] (size_t index) const
 Retrieve a reference to the element at position specified by index in current array. More...
 
void RemoveAll ()
 Remove all the element from current array. More...
 
void RemoveAt (size_t index)
 Remove the element in position specified by index. More...
 

Detailed Description

This class represents an array of TableCellData objects,inserted in the order of the displayed table from left to right.

Constructor & Destructor Documentation

◆ TableCellDataColArray()

foxit::addon::tablegenerator::TableCellDataColArray::TableCellDataColArray ( const TableCellDataColArray other)

Constructor, with another array object.

Parameters
[in]otherAnother array object.

Member Function Documentation

◆ Add()

void foxit::addon::tablegenerator::TableCellDataColArray::Add ( const TableCellData element)

Add an element to the end of current array.

Parameters
[in]elementNew element to be added to current array.
Returns
None.

◆ GetAt()

TableCellData foxit::addon::tablegenerator::TableCellDataColArray::GetAt ( size_t  index) const

Retrieve a copy of the element at position specified by index in current array.

Parameters
[in]indexAn index to specify which element is to be retrieved.
Returns
A copy of an element.

◆ GetSize()

size_t foxit::addon::tablegenerator::TableCellDataColArray::GetSize ( ) const

Get the size of elements in current array.

Returns
The size.

◆ InsertAt()

void foxit::addon::tablegenerator::TableCellDataColArray::InsertAt ( size_t  index,
const TableCellData element 
)

Insert an element before the position specified by index.

Parameters
[in]indexAn index to specify where to insert the new element. Valid range: from 0 to (size-1). size is the size of elements in current array.
[in]elementNew element to be inserted to current array.
Returns
None.

◆ operator=()

TableCellDataColArray& foxit::addon::tablegenerator::TableCellDataColArray::operator= ( const TableCellDataColArray other)

Assign operator.

Parameters
[in]otherAnother array object, whose value will be assigned to current object.
Returns
Reference to current object itself.

◆ operator[]()

TableCellData& foxit::addon::tablegenerator::TableCellDataColArray::operator[] ( size_t  index) const

Retrieve a reference to the element at position specified by index in current array.

Parameters
[in]indexAn index to specify which element is to be retrieved.
Returns
Reference to an element.

◆ RemoveAll()

void foxit::addon::tablegenerator::TableCellDataColArray::RemoveAll ( )

Remove all the element from current array.

Returns
None.

◆ RemoveAt()

void foxit::addon::tablegenerator::TableCellDataColArray::RemoveAt ( size_t  index)

Remove the element in position specified by index.

Parameters
[in]indexAn index to specify which element is to be removed. Valid range: from 0 to (size-1). size is the size of elements in current array.
Returns
None.