<html> <head> <title>Interface XSheetOutline</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="XSheetOutline-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Spreadsheets/Sheet_Outline" 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 XSheetOutline</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>provides methods to access the outlines of a sheet. </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/Sheet_Outline">Spreadsheets - Sheet Outline</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="#group">group</a></td> <td class="imsum_right">creates an outline group. </td> </tr> <tr> <td class="imsum_left"><a href="#ungroup">ungroup</a></td> <td class="imsum_right">removes outline groups. </td> </tr> <tr> <td class="imsum_left"><a href="#autoOutline">autoOutline</a></td> <td class="imsum_right">creates outline groups from formula references in a range. </td> </tr> <tr> <td class="imsum_left"><a href="#clearOutline">clearOutline</a></td> <td class="imsum_right">removes all outline groups from the sheet. </td> </tr> <tr> <td class="imsum_left"><a href="#hideDetail">hideDetail</a></td> <td class="imsum_right">collapses an outline group. </td> </tr> <tr> <td class="imsum_left"><a href="#showDetail">showDetail</a></td> <td class="imsum_right">reopens an outline group. </td> </tr> <tr> <td class="imsum_left"><a href="#showLevel">showLevel</a></td> <td class="imsum_right">shows all outlined groups below a specific level. </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="group" class="membertitle">group</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>group</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/CellRangeAddress.html">CellRangeAddress</a></td> <td valign="bottom"> aRange,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/TableOrientation.html">TableOrientation</a></td> <td valign="bottom"> nOrientation );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>creates an outline group. </dd> <dt><b>Parameter aRange</b></dt> <dd>contains the range of rows or columns, depending on the parameter nOrientation. </dd> <dt><b>Parameter nOrientation</b></dt> <dd>the orientation of the new outline (columns or rows). </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ungroup" class="membertitle">ungroup</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>ungroup</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/CellRangeAddress.html">CellRangeAddress</a></td> <td valign="bottom"> aRange,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/TableOrientation.html">TableOrientation</a></td> <td valign="bottom"> nOrientation );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>removes outline groups. </dd> <dd><p>In the specified range, all outline groups on the innermost level are removed.</p> </dd> <dt><b>Parameter aRange</b></dt> <dd>contains the range of rows or columns, depending on the parameter nOrientation. </dd> <dt><b>Parameter nOrientation</b></dt> <dd>the orientation of the outlines to remove (columns or rows). </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="autoOutline" class="membertitle">autoOutline</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>autoOutline</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/CellRangeAddress.html">CellRangeAddress</a></td> <td valign="bottom"> aRange );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>creates outline groups from formula references in a range. </dd> <dt><b>Parameter aRange</b></dt> <dd>the cell range for which outlines are generated. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="clearOutline" class="membertitle">clearOutline</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>clearOutline</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>removes all outline groups from the sheet. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="hideDetail" class="membertitle">hideDetail</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>hideDetail</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/CellRangeAddress.html">CellRangeAddress</a></td> <td valign="bottom"> aRange );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>collapses an outline group. </dd> <dt><b>Parameter aRange</b></dt> <dd>the cell range for which the outlines are collapsed. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="showDetail" class="membertitle">showDetail</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>showDetail</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/CellRangeAddress.html">CellRangeAddress</a></td> <td valign="bottom"> aRange );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>reopens an outline group. </dd> <dt><b>Parameter aRange</b></dt> <dd>the cell range for which the outlines are reopened. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="showLevel" class="membertitle">showLevel</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>showLevel</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> nLevel,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/TableOrientation.html">TableOrientation</a></td> <td valign="bottom"> nOrientation );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>shows all outlined groups below a specific level. </dd> <dt><b>Parameter nLevel</b></dt> <dd>all outline levels from 1 to this value will be opened and the higher levels will be closed. </dd> <dt><b>Parameter nOrientation</b></dt> <dd>the orientation of the outlines (columns or rows). </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>