LibreOffice
LibreOffice 6.4 SDK API Reference
Public Member Functions | List of all members
XCellRangesAccess Interface Referencepublished

provides access to the cells or to sub-ranges of all sheets. More...

import"XCellRangesAccess.idl";

Inheritance diagram for XCellRangesAccess:
XInterface Spreadsheets

Public Member Functions

com::sun::star::table::XCell getCellByPosition ([in] long nColumn, [in] long nRow, [in] long nSheet) raises ( com::sun::star::lang::IndexOutOfBoundsException )
 Returns a single cell within the range. More...
 
com::sun::star::table::XCellRange getCellRangeByPosition ([in] long nLeft, [in] long nTop, [in] long nRight, [in] long nBottom, [in] long nSheet) raises ( com::sun::star::lang::IndexOutOfBoundsException )
 Returns a sub-range of cells within the range. More...
 
sequence< com::sun::star::table::XCellRangegetCellRangesByName ([in] string aRange) raises ( com::sun::star::lang::IllegalArgumentException )
 Returns a sub-range of cells within the range. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

provides access to the cells or to sub-ranges of all sheets.

See also
com::sun::star::sheet::Spreadsheets

Member Function Documentation

◆ getCellByPosition()

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

Returns a single cell within the range.

Parameters
nColumnis the column index of the cell inside the sheet.
nRowis the row index of the cell inside the sheet.
nSheetis the sheet index of the sheet inside the document.
Returns
the specified cell.
Exceptions
com::sun::star::lang::IndexOutOfBoundsExceptionif 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,
[in] long  nSheet 
)
raises (com::sun::star::lang::IndexOutOfBoundsException
)

Returns a sub-range of cells within the range.

Parameters
nLeftis the column index of the first cell inside the range.
nTopis the row index of the first cell inside the range.
nRightis the column index of the last cell inside the range.
nBottomis the row index of the last cell inside the range.
nSheetis the sheet index of the sheet inside the document.
Returns
the specified cell range.
Exceptions
com::sun::star::lang::IndexOutOfBoundsExceptionif an index is outside the dimensions of this range.
See also
com::sun::star::table::CellRange

◆ getCellRangesByName()

sequence<com::sun::star::table::XCellRange> getCellRangesByName ( [in] string  aRange)
raises (com::sun::star::lang::IllegalArgumentException
)

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 "Sheet1.A1:C5" or "$Sheet1.$B$2" or even defined names for cell ranges such as "MySpecialCell".

Parameters
aRangethe name of the sub-range.
Returns
the specified cell ranges.
See also
com::sun::star::table::CellRange

The documentation for this interface was generated from the following file: