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

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

interface XTextTable

Base Interface
com::sun::star::text::XTextContent

Description
manages a text table.


Known Services which Export this Interface

com::sun::star::text::TextTable is a table of text cells which is anchored to a surrounding text.

Methods' Summary

initialize determines the numbers of rows and columns of the text table.
getRows
getColumns
getCellByName
getCellNames
createCursorByCellName creates a text table cursor and returns the XTextTableCursor interface.

Methods' Details

initialize
 
void
initialize(
[ in ] long nRows,
[ in ] long nColumns );

Description
determines the numbers of rows and columns of the text table.

This method must be called before the object is inserted via .

getRows
 
com::sun::star::table::XTableRows
getRows();
Returns
the access object for the text table rows.
See also
com::sun::star::table::XTableRows
getColumns
 
com::sun::star::table::XTableColumns
getColumns();
Returns
the access object for the text table columns.
See also
com::sun::star::table::XTableColumns
getCellByName
 
com::sun::star::table::XCell
getCellByName(
[ in ] string aCellName );

Returns
the XCell interface of the cell with the specified name.
Parameter aCellName
is a concatenation of the alphanumeric column name and the index of the row.

Example: The cell in the 4th column and third row has the name "D3".

In cells that are split, the naming convention is more complex. In this case the name is a concatenation of the former cell name (i.e. "D3") and the number of the new column and row index inside of the original table cell separated by dots. This is done recursively.

Example: If the cell "D3" is horizontally split, it now contains the cells "D3.1.1" and "D3.1.2"

See also
com::sun::star::table::XCell
getCellNames
 
sequence< string >
getCellNames();
Returns
the names of all cells of this text table.
createCursorByCellName
 
com::sun::star::text::XTextTableCursor
createCursorByCellName(
[ in ] string aCellName );

Description
creates a text table cursor and returns the XTextTableCursor interface.

Initially the cursor is positioned in the cell with the specified name.


Top of Page