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

(Global Index)

Syntax

interface XTextTable : com::sun::star::text::XTextContent ;

Description

manages a text table.

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

Known Services Which Export this Interface

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

Method Details



initialize

Syntax

void initialize (
long nRows,
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

Syntax

com::sun::star::table::XTableRows getRows ();

Returns

the access object for the text table rows.

See also

XTableRows

getColumns

Syntax

com::sun::star::table::XTableColumns getColumns ();

Returns

the access object for the text table columns.

See also

XTableColumns

getCellByName

Syntax

com::sun::star::table::XCell getCellByName (
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

XCell

getCellNames

Syntax

sequence< string > getCellNames ();

Returns

the names of all cells of this text table.

createCursorByCellName

Syntax

com::sun::star::text::XTextTableCursor createCursorByCellName (
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