interface XTextTableCursor in module com::sun::star::text::

(Global Index)

Syntax

interface XTextTableCursor : com::sun::star::uno::XInterface ;

Description

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

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

Known Services Which Export this Interface

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

Method Details



getRangeName

Syntax

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

Syntax

boolean gotoCellByName (
string aCellName,
boolean bExpand );

Description

moves the cursor to the cell with the specified name.


goLeft

Syntax

boolean goLeft (
short nCount,
boolean bExpand );

Description

moves the cursor to the left neighbor.


goRight

Syntax

boolean goRight (
short nCount,
boolean bExpand );

Description

moves the cursor to the right neighbor.


goUp

Syntax

boolean goUp (
short nCount,
boolean bExpand );

Description

moves the cursor to the top neighbor.


goDown

Syntax

boolean goDown (
short nCount,
boolean bExpand );

Description

moves the cursor to the bottom neighbor cell.


gotoStart

Syntax

void gotoStart (
boolean bExpand );

Description

moves the cursor to the top left cell of the table.


gotoEnd

Syntax

void gotoEnd (
boolean bExpand );

Description

moves the cursor to the bottom right cell of the table.


mergeRange

Syntax

boolean mergeRange ();

Description

merges the selected range of cells.


splitRange

Syntax

boolean splitRange (
short Count,
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