Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

interface XTextTableCursor
Description
The TextTableCursor provide methods to navigate throught the table structure, to merge and split cells
See also
TextTable, TextTableCursor, Cell, XTextTable

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

See also
com::sun:star::text::CellRange
gotoCellByName
boolean
gotoCellByName( [in] string  aCellName,
[in] boolean  bExpand );

Description
moves the cursor to the cell with the specified name.
Parameter aCellName
specifies the name of the cell to go to.
Parameter bExpand
determines wether the selection is to be expanded.
See also
Cell
goLeft
boolean
goLeft( [in] short  nCount,
[in] boolean  bExpand );

Description
moves the cursor to the left neighbor.
Parameter nCount
the number of cells to move.
Parameter bExpand
determines wether the selection is to be expanded.
goRight
boolean
goRight( [in] short  nCount,
[in] boolean  bExpand );

Description
moves the cursor to the right neighbor.
Parameter nCount
the number of cells to move.
Parameter bExpand
determines wether the selection is to be expanded.
goUp
boolean
goUp( [in] short  nCount,
[in] boolean  bExpand );

Description
moves the cursor to the top neighbor.
Parameter nCount
the number of cells to move.
Parameter bExpand
determines wether the selection is to be expanded.
goDown
boolean
goDown( [in] short  nCount,
[in] boolean  bExpand );

Description
moves the cursor to the bottom neighbor cell.
Parameter nCount
the number of cells to move.
Parameter bExpand
determines wether the selection is to be expanded.
gotoStart
void
gotoStart( [in] boolean  bExpand );

Description
moves the cursor to the top left cell of the table.
Parameter bExpand
determines wether the selection is to be expanded.
gotoEnd
void
gotoEnd( [in] boolean  bExpand );

Description
moves the cursor to the bottom right cell of the table.
Parameter bExpand
determines wether the selection is to be expanded.
mergeRange
boolean
mergeRange();

Description
merges the selected range of cells.
See also
com:sun::star::CellRange
splitRange
boolean
splitRange( [in] short  nCount,
[in] boolean  bHorizontal );

Description
splits the range of cells.
Parameter nCount
specifies the number of new cells that will be created for each cell contained in the range.
Parameter bHorizontal
true if the range should be split vertically. Otherwise it will be split horizontally.
See also
com:sun::star::Cell, com:sun::star::CellRange
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.