Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

com :: sun :: star :: text ::

interface XTextTableCursor

Base Interface
com::sun::star::uno::XInterface

Description
The TextTableCursor provide methods to navigate throught the table structure, to merge and split cells


Known Services which Export this Interface

com::sun::star::text::TextTableCursor specifies a cursor in text tables.

Methods' Summary

getRangeName
gotoCellByName moves the cursor to the cell with the specified name.
goLeft moves the cursor to the left neighbor.
goRight moves the cursor to the right neighbor.
goUp moves the cursor to the top neighbor.
goDown moves the cursor to the bottom neighbor cell.
gotoStart moves the cursor to the top left cell of the table.
gotoEnd moves the cursor to the bottom right cell of the table.
mergeRange merges the selected range of cells.
splitRange splits the range of cells. The count specifies the number of new cells that will be created for each cell contained in the range.

Methods' Details

getRangeName
 
string
getRangeName();
Returns
the name of the cell range that is selected by this cursor.

The name is the cell name of the top left table cell of the range contatenated by ':' with the table cell name of the bottom left table cell of the cell range. If the range consists of one table cell only then the name of that table cell is returned.

gotoCellByName
 
boolean
gotoCellByName(
[ in ] string aCellName,
[ in ] boolean bExpand );

Description
moves the cursor to the cell with the specified name.
goLeft
 
boolean
goLeft(
[ in ] short nCount,
[ in ] boolean bExpand );

Description
moves the cursor to the left neighbor.
goRight
 
boolean
goRight(
[ in ] short nCount,
[ in ] boolean bExpand );

Description
moves the cursor to the right neighbor.
goUp
 
boolean
goUp(
[ in ] short nCount,
[ in ] boolean bExpand );

Description
moves the cursor to the top neighbor.
goDown
 
boolean
goDown(
[ in ] short nCount,
[ in ] boolean bExpand );

Description
moves the cursor to the bottom neighbor cell.
gotoStart
 
void
gotoStart(
[ in ] boolean bExpand );

Description
moves the cursor to the top left cell of the table.
gotoEnd
 
void
gotoEnd(
[ in ] boolean bExpand );

Description
moves the cursor to the bottom right cell of the table.
mergeRange
 
boolean
mergeRange();
Description
merges the selected range of cells.
splitRange
 
boolean
splitRange(
[ in ] short Count,
[ in ] boolean Horizontal );

Description
splits the range of cells. The count specifies the number of new cells that will be created for each cell contained in the range.

Top of Page