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

com :: sun :: star :: table ::

interface XCellRange

Base Interface
com::sun::star::uno::XInterface

Description
provides access to the cells or to sub-ranges of a cell range.
See also
com::sun::star::table::CellRange


Known Services which Export this Interface

com::sun::star::table::CellRange represents a range of of cells within a table.
com::sun::star::table::TableColumn represents a special cell range containing all cells of a single specific column in a table or spreadsheet.
com::sun::star::table::TableRow represents a special cell range containing all cells of a single specific row in a table or spreadsheet.
com::sun::star::text::CellRange area of cells within a spreadsheet (text).
com::sun::star::text::TextTable is a table of text cells which is anchored to a surrounding text.

Methods' Summary

getCellByPosition Returns a single cell within the range.
getCellRangeByPosition Returns a sub-range of cells within the range.
getCellRangeByName Returns a sub-range of cells within the range.

Methods' Details

getCellByPosition
 
com::sun::star::table::XCell
getCellByPosition(
[ in ] long nColumn,
[ in ] long nRow )
raises ( com::sun::star::lang::IndexOutOfBoundsException );

Description
Returns a single cell within the range.
Parameter nColumn
is the column index of the cell inside the range.
Parameter nRow
is the row index of the cell inside the range.
Returns
the specified cell.
Throws
com::sun::star::lang::IndexOutOfBoundsException if an index is outside the dimensions of this range.
See also
com::sun::star::table::Cell
getCellRangeByPosition
 
com::sun::star::table::XCellRange
getCellRangeByPosition(
[ in ] long nLeft,
[ in ] long nTop,
[ in ] long nRight,
[ in ] long nBottom )
raises ( com::sun::star::lang::IndexOutOfBoundsException );

Description
Returns a sub-range of cells within the range.
Parameter nLeft
is the column index of the first cell inside the range.
Parameter nTop
is the row index of the first cell inside the range.
Parameter nRight
is the column index of the last cell inside the range.
Parameter nBottom
is the row index of the last cell inside the range.
Returns
the specified cell range.
Throws
com::sun::star::lang::IndexOutOfBoundsException if an index is outside the dimensions of this range.
See also
com::sun::star::table::CellRange
getCellRangeByName
 
com::sun::star::table::XCellRange
getCellRangeByName(
[ in ] string aRange );

Description
Returns a sub-range of cells within the range.

The sub-range is specified by its name. The format of the range name is dependent of the context of the table. In spreadsheets valid names may be "A1:C5" or "$B$2" or even defined names for cell ranges such as "MySpecialCell".

Parameter aRange
the name of the sub-range.
Returns
the specified cell range.
See also
com::sun::star::table::CellRange

Top of Page