Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

:: com :: sun :: star :: sheet ::

interface XSheetCellCursor
Base Interfaces
XSheetCellCursor
┗ XSheetCellRange
   ┗ ::com::sun::star::table::XCellRange
XSheetCellRange
(referenced interface's summary:)
provides access to the spreadsheet that contains a cell range.
Description
provides advanced methods to control the position of a cursor in a spreadsheet.
See also
SheetCellCursor
Developers Guide
Spreadsheets - Cell Cursor
Methods' Summary
collapseToCurrentRegion expands the cursor into the region containing the cells to which it currently points.  
collapseToCurrentArray collapses the cursor into the range of the array formula to which it is currently pointing.  
collapseToMergedArea expands the cursor to merged cell ranges.  
expandToEntireColumns expands the cursor to include the entire columns of the cells to which it is currently pointing.  
expandToEntireRows expands the cursor to include the entire rows of the cells to which it is currently pointing.  
collapseToSize changes the size of a cursor range.  
Methods' Details
collapseToCurrentRegion
void
collapseToCurrentRegion();
Description
expands the cursor into the region containing the cells to which it currently points.

A region is a cell range bounded by empty cells.
collapseToCurrentArray
void
collapseToCurrentArray();
Description
collapses the cursor into the range of the array formula to which it is currently pointing.

To get the correct result, the top left cell of the original cursor must point to any cell containing an array formula. If not, the cursor is left unchanged.
collapseToMergedArea
void
collapseToMergedArea();
Description
expands the cursor to merged cell ranges.

Expands the current cursor range in a way so that all merged cell ranges intersecting the current range will fit completely. If the cursor does not point to any range with merged cells, it is left unchanged.
expandToEntireColumns
void
expandToEntireColumns();
Description
expands the cursor to include the entire columns of the cells to which it is currently pointing.
expandToEntireRows
void
expandToEntireRows();
Description
expands the cursor to include the entire rows of the cells to which it is currently pointing.
collapseToSize
void
collapseToSize( [in] long  nColumns,
[in] long  nRows );
Description
changes the size of a cursor range.

The top left cell of the cursor keeps unmodified.

Parameter nColumns
the number of columns of the new cursor range.
Parameter nRows
the number of rows of the new cursor range.
Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.