<html> <head> <title>Interface XSheetCellCursor</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XSheetCellCursor-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Spreadsheets/Cell_Cursor" class="navimain">Devguide</a></td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">sheet</a> :: </p> </td> </tr> <tr> <td class="title">interface XSheetCellCursor</td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XSheetCellCursor</strong> ┗ <a href="XSheetCellRange.html">XSheetCellRange</a> ┗ ::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/XCellRange.html">XCellRange</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left"><a href="XSheetCellRange.html">XSheetCellRange</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>provides access to the spreadsheet that contains a cell range. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>provides advanced methods to control the position of a cursor in a spreadsheet. </dd> <dt><b>See also</b></dt> <dd><a href="SheetCellCursor.html">SheetCellCursor</a></dd> </dl> <a name="devmanual"> </a><dl> <dt><b>Developers Guide</b></dt> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Spreadsheets/Cell_Cursor">Spreadsheets - Cell Cursor</a></dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#collapseToCurrentRegion">collapseToCurrentRegion</a></td> <td class="imsum_right">expands the cursor into the region containing the cells to which it currently points. </td> </tr> <tr> <td class="imsum_left"><a href="#collapseToCurrentArray">collapseToCurrentArray</a></td> <td class="imsum_right">collapses the cursor into the range of the array formula to which it is currently pointing. </td> </tr> <tr> <td class="imsum_left"><a href="#collapseToMergedArea">collapseToMergedArea</a></td> <td class="imsum_right">expands the cursor to merged cell ranges. </td> </tr> <tr> <td class="imsum_left"><a href="#expandToEntireColumns">expandToEntireColumns</a></td> <td class="imsum_right">expands the cursor to include the entire columns of the cells to which it is currently pointing. </td> </tr> <tr> <td class="imsum_left"><a href="#expandToEntireRows">expandToEntireRows</a></td> <td class="imsum_right">expands the cursor to include the entire rows of the cells to which it is currently pointing. </td> </tr> <tr> <td class="imsum_left"><a href="#collapseToSize">collapseToSize</a></td> <td class="imsum_right">changes the size of a cursor range. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="collapseToCurrentRegion" class="membertitle">collapseToCurrentRegion</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>collapseToCurrentRegion</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>expands the cursor into the region containing the cells to which it currently points. </dd> <dd><p>A region is a cell range bounded by empty cells.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="collapseToCurrentArray" class="membertitle">collapseToCurrentArray</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>collapseToCurrentArray</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>collapses the cursor into the range of the array formula to which it is currently pointing. </dd> <dd><p>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.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="collapseToMergedArea" class="membertitle">collapseToMergedArea</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>collapseToMergedArea</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>expands the cursor to merged cell ranges. </dd> <dd><p>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.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="expandToEntireColumns" class="membertitle">expandToEntireColumns</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>expandToEntireColumns</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>expands the cursor to include the entire columns of the cells to which it is currently pointing. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="expandToEntireRows" class="membertitle">expandToEntireRows</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>expandToEntireRows</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>expands the cursor to include the entire rows of the cells to which it is currently pointing. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="collapseToSize" class="membertitle">collapseToSize</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>collapseToSize</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nColumns,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nRows );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>changes the size of a cursor range. </dd> <dd><p>The top left cell of the cursor keeps unmodified. </p> </dd> <dt><b>Parameter nColumns</b></dt> <dd>the number of columns of the new cursor range. </dd> <dt><b>Parameter nRows</b></dt> <dd>the number of rows of the new cursor range. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>