Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.3 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

interface XTextTable
Base Interfaces
XTextTableXTextContent
   ┗ ::com::sun::star::lang::XComponent

XTextContent
(referenced interface's summary:)
enables objects to be inserted into a text and to provide their location in a text once they are inserted into it.
Description
manages a text table.
See also
TextTable, Cell

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 after the object is created and before the object is insert or attached elsewhere.

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 ::com::sun::star::table::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::Cell, ::com::sun::star::table::XCell
getCellNames
sequence< string >
getCellNames();

Returns
the names of all cells of this text table.
createCursorByCellName
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.

See also
TextTableCursor
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.