Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: sheet ::
interface XCellRangesAccess
Description provides access to the cells or to sub-ranges of all sheets. See also Spreadsheets

Methods' Summary
getCellByPosition | Returns a single cell within the range.
getCellRangeByPosition | Returns a sub-range of cells within the range.
getCellRangesByName | Returns a sub-range of cells within the range.

Methods' Details
getCellByPosition
::com::sun::star::table::XCell
getCellByPosition( | [in] long | nColumn,
| [in] long | nRow,
| [in] long | nSheet )
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 sheet. Parameter nRow is the row index of the cell inside the sheet. Parameter nSheet is the sheet index of the sheet inside the document. 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,
| [in] long | nSheet )
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. Parameter nSheet is the sheet index of the sheet inside the document. 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
getCellRangesByName
sequence< ::com::sun::star::table::XCellRange >
getCellRangesByName( | [in] string | aRange )
raises( | ::com::sun::star::lang::IllegalArgumentException );
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 "Sheet1.A1:C5" or "$Sheet1.$B$2" or even defined names for cell ranges such as "MySpecialCell". Parameter aRange the name of the sub-range. Returns the specified cell ranges. See also ::com::sun::star::table::CellRange

Top of Page

Copyright © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.