<html> <head> <title>Service SubTotalDescriptor</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="SubTotalDescriptor-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Spreadsheets/Subtotals" 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">Services' Summary</td> <td class="navisub"><a href="#InterfacesSummary" class="navisub">Interfaces' Summary</a></td> <td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</a></td> <td class="navisub">Services' Details</td> <td class="navisub"><a href="#InterfacesDetails" class="navisub">Interfaces' Details</a></td> <td class="navisub"><a href="#PropertiesDetails" class="navisub">Properties' 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">sheet</a> :: </p> </td> </tr> <tr> <td class="title">service SubTotalDescriptor</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>represents a description of how subtotals are created. </dd> <dd><p>The descriptor contains properties and a collection of subtotal fields which control the behavior of operation.</p> </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/Subtotals">Spreadsheets - Subtotals</a></dd> </dl> </td> </tr> </table> <hr> <a name="InterfacesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces - Summary</td> </tr> <tr> <td class="imsum_left"><a href="XSubTotalDescriptor.html">XSubTotalDescriptor</a></td> <td class="imsum_right"><p>provides access to the collection of subtotal fields. </p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XEnumerationAccess.html">XEnumerationAccess</a></td> <td class="imsum_right"><p>creates an enumeration of all sub total fields. (<a href="#XEnumerationAccess">details</a>)</p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XIndexAccess.html">XIndexAccess</a></td> <td class="imsum_right"><p>provides access to the sub total fields in the collection via index. </p> </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"><p>provides access to the properties. </p> </td> </tr> </table> <a name="PropertiesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Properties' Summary</td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#InsertPageBreaks">InsertPageBreaks</a></td> <td class="imsum_right">specifies if page breaks are inserted after each group change. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#IsCaseSensitive">IsCaseSensitive</a></td> <td class="imsum_right">specifies if the case of letters is important when comparing entries. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#EnableUserSortList">EnableUserSortList</a></td> <td class="imsum_right">specifies if a user defined sorting list is used. </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#UserSortListIndex">UserSortListIndex</a></td> <td class="imsum_right">specifies which user defined sorting list is used. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#BindFormatsToContent">BindFormatsToContent</a></td> <td class="imsum_right">specifies if cell formats are moved with the contents they belong to. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#EnableSort">EnableSort</a></td> <td class="imsum_right">specifies if the contents of the fields will be sorted to groups while performing a subtotal operation. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#SortAscending">SortAscending</a></td> <td class="imsum_right">specifies the sorting order if <a href="SubTotalDescriptor.html">SubTotalDescriptor</a>::<a href="SubTotalDescriptor.html#EnableSort">EnableSort</a> is set to <b>true</b>. </td> </tr> <tr> <td class="imsum_left">[ readonly ] long<br> <a href="#MaxFieldCount">MaxFieldCount</a></td> <td class="imsum_right">returns the maximum number of subtotal fields the descriptor can hold. </td> </tr> </table> <a name="InterfacesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces - Details</td> </tr> <tr/> <tr> <td class="imdetail"><a name="XSubTotalDescriptor" class="membertitle"><a href="XSubTotalDescriptor.html">XSubTotalDescriptor</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>provides access to the collection of subtotal fields. </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XEnumerationAccess" class="membertitle">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XEnumerationAccess.html">XEnumerationAccess</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>creates an enumeration of all sub total fields. </dd> <dt><b>See also</b></dt> <dd><a href="SubTotalFieldsEnumeration.html">SubTotalFieldsEnumeration</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XIndexAccess" class="membertitle">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XIndexAccess.html">XIndexAccess</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>provides access to the sub total fields in the collection via index. </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XPropertySet" class="membertitle">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>provides access to the properties. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="PropertiesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Properties' Details</td> </tr> <tr> <td class="imdetail"><a name="InsertPageBreaks" class="membertitle">InsertPageBreaks</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>InsertPageBreaks</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies if page breaks are inserted after each group change. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="IsCaseSensitive" class="membertitle">IsCaseSensitive</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>IsCaseSensitive</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies if the case of letters is important when comparing entries. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="EnableUserSortList" class="membertitle">EnableUserSortList</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>EnableUserSortList</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies if a user defined sorting list is used. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="UserSortListIndex" class="membertitle">UserSortListIndex</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>UserSortListIndex</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies which user defined sorting list is used. </dd> <dd><p>This property is only used if <a href="SubTotalDescriptor.html">SubTotalDescriptor</a>::<a href="SubTotalDescriptor.html#EnableUserSortList">EnableUserSortList</a> is <b>true</b>.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="BindFormatsToContent" class="membertitle">BindFormatsToContent</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>BindFormatsToContent</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies if cell formats are moved with the contents they belong to. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="EnableSort" class="membertitle">EnableSort</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>EnableSort</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies if the contents of the fields will be sorted to groups while performing a subtotal operation. </dd> </dl> </td> </tr> </table> </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>boolean <b>SortAscending</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the sorting order if <a href="SubTotalDescriptor.html">SubTotalDescriptor</a>::<a href="SubTotalDescriptor.html#EnableSort">EnableSort</a> is set to <b>true</b>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="MaxFieldCount" class="membertitle">MaxFieldCount</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] long <b>MaxFieldCount</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>returns the maximum number of subtotal fields the descriptor can hold. </dd> <dd><p>This read-only property indicates the maximum count of fields the current implementation supports.</p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <br> <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>
