<html> <head> <title>Interface XGroup</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="XGroup-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</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">Methods' Summary</td> <td class="navisub"><a href="#AttributesSummary" class="navisub">Attributes' Summary</a></td> <td class="navisub">Methods' Details</td> <td class="navisub"><a href="#AttributesDetails" class="navisub">Attributes' Details</a></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">report</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XGroup</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XGroup</strong> ┣ ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XChild.html">XChild</a> ┣ ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a> ┣ ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a> ┗ <a href="XFunctionsSupplier.html">XFunctionsSupplier</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XChild.html">XChild</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows access to the groups collection of the report. </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows access to the properties of the instance. </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows life-time control of group instances. </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XFunctionsSupplier.html">XFunctionsSupplier</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>gives access to functions defined in the group definition. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>identifies a <a href="XGroup.html">XGroup</a>. A group is always a child of the groups collection in the report. </dd> <dt><b>See also</b></dt> <dd><a href="XReportDefinition.html">XReportDefinition</a>, <a href="XGroups.html">XGroups</a></dd> </dl> </td> </tr> </table> <hr> <a name="AttributesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Attributes' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#SortAscending">SortAscending</a></td> <td class="imsum_right">Defines if the group is sorted ascending or descending. The default is <b>true</b>. </td> </tr> <tr> <td class="imsum_left"><a href="#HeaderOn">HeaderOn</a></td> <td class="imsum_right">Defines if a group has a header. </td> </tr> <tr> <td class="imsum_left"><a href="#FooterOn">FooterOn</a></td> <td class="imsum_right">Defines if a group has a footer. </td> </tr> <tr> <td class="imsum_left"><a href="#Header">Header</a></td> <td class="imsum_right">returns the group header. </td> </tr> <tr> <td class="imsum_left"><a href="#Footer">Footer</a></td> <td class="imsum_right">returns the group footer. </td> </tr> <tr> <td class="imsum_left"><a href="#GroupOn">GroupOn</a></td> <td class="imsum_right">Specifies how to group data. </td> </tr> <tr> <td class="imsum_left"><a href="#GroupInterval">GroupInterval</a></td> <td class="imsum_right">Defines an interval value that rows are grouped by. </td> </tr> <tr> <td class="imsum_left"><a href="#KeepTogether">KeepTogether</a></td> <td class="imsum_right">Specifies if a group header, detail, and footer section is printed on the same page. </td> </tr> <tr> <td class="imsum_left"><a href="#Groups">Groups</a></td> <td class="imsum_right">Specifies the parent of the group. </td> </tr> <tr> <td class="imsum_left"><a href="#Expression">Expression</a></td> <td class="imsum_right">Defines either a column name or a expression. </td> </tr> <tr> <td class="imsum_left"><a href="#StartNewColumn">StartNewColumn</a></td> <td class="imsum_right">Specifies that the group header should always be printed on a new column. </td> </tr> <tr> <td class="imsum_left"><a href="#ResetPageNumber">ResetPageNumber</a></td> <td class="imsum_right">Specifies that the group header should always be printed on a new page and the reset of the page number to zero. </td> </tr> </table> <a name="AttributesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Attributes' Details</td> </tr> <tr> <td class="imdetail"><a name="SortAscending" class="membertitle">SortAscending</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] boolean <b>SortAscending</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Defines if the group is sorted ascending or descending. The default is <b>true</b>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="HeaderOn" class="membertitle">HeaderOn</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] boolean <b>HeaderOn</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Defines if a group has a header. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="FooterOn" class="membertitle">FooterOn</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] boolean <b>FooterOn</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Defines if a group has a footer. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Header" class="membertitle">Header</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] <a href="XSection.html">XSection</a> <b>Header</b><dl> <dd>get raises (::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the group header. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> If the group has the header disabled. </dd> <dt><b>See also</b></dt> <dd><a href="XSection.html">XSection</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Footer" class="membertitle">Footer</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly bound ] <a href="XSection.html">XSection</a> <b>Footer</b><dl> <dd>get raises (::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the group footer. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> If the group has the footer disabled. </dd> <dt><b>See also</b></dt> <dd><a href="XSection.html">XSection</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="GroupOn" class="membertitle">GroupOn</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] short <b>GroupOn</b><dl> <dd>set raises (::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>Specifies how to group data. </dd> <dt><b>See also</b></dt> <dd><a href="GroupOn.html">GroupOn</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="GroupInterval" class="membertitle">GroupInterval</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] long <b>GroupInterval</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Defines an interval value that rows are grouped by. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="KeepTogether" class="membertitle">KeepTogether</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] short <b>KeepTogether</b><dl> <dd>set raises (::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>Specifies if a group header, detail, and footer section is printed on the same page. </dd> <dt><b>See also</b></dt> <dd><a href="KeepTogether.html">KeepTogether</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Groups" class="membertitle">Groups</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] <a href="XGroups.html">XGroups</a> <b>Groups</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Specifies the parent of the group. </dd> <dt><b>See also</b></dt> <dd>XChild</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Expression" class="membertitle">Expression</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] string <b>Expression</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Defines either a column name or a expression. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="StartNewColumn" class="membertitle">StartNewColumn</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] boolean <b>StartNewColumn</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Specifies that the group header should always be printed on a new column. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ResetPageNumber" class="membertitle">ResetPageNumber</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] boolean <b>ResetPageNumber</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Specifies that the group header should always be printed on a new page and the reset of the page number to zero. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "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 <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
