<html> <head> <title>Struct DataPilotFieldGroupInfo</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="DataPilotFieldGroupInfo-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"><a href="#Elements" class="navisub">Elements' Summary</a></td> <td class="navisub"><a href="#ElementDetails" class="navisub">Elements' 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">struct DataPilotFieldGroupInfo</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>contains the grouping information of a <a href="DataPilotField.html">DataPilotField</a>. </dd> </dl> </td> </tr> </table> <hr> <a name="Elements"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Elements' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#HasAutoStart">HasAutoStart</a></td> <td class="imsum_right">specifies whether the start value for the grouping is taken automatically from the minimum of the item values. </td> </tr> <tr> <td class="imsum_left"><a href="#HasAutoEnd">HasAutoEnd</a></td> <td class="imsum_right">specifies whether the end value for the grouping is taken automatically from the maximum of the item values. </td> </tr> <tr> <td class="imsum_left"><a href="#HasDateValues">HasDateValues</a></td> <td class="imsum_right">specifies whether date values are grouped by ranges of days. </td> </tr> <tr> <td class="imsum_left"><a href="#Start">Start</a></td> <td class="imsum_right">specifies the start value for the grouping if <a href="#HasAutoStart">HasAutoStart</a> is set to <b>false</b>. </td> </tr> <tr> <td class="imsum_left"><a href="#End">End</a></td> <td class="imsum_right">specifies the end value for the grouping if <a href="#HasAutoEnd">HasAutoEnd</a> is set to <b>false</b>. </td> </tr> <tr> <td class="imsum_left"><a href="#Step">Step</a></td> <td class="imsum_right">specifies the size of the ranges for numeric or day grouping. </td> </tr> <tr> <td class="imsum_left"><a href="#GroupBy">GroupBy</a></td> <td class="imsum_right">specifies the grouping of the date values. </td> </tr> <tr> <td class="imsum_left"><a href="#SourceField">SourceField</a></td> <td class="imsum_right">contains the source DataPilot field grouping is based on. Will be <b>NULL</b> if this field is not grouped or contains numeric grouping. </td> </tr> <tr> <td class="imsum_left"><a href="#Groups">Groups</a></td> <td class="imsum_right">specifies the named groups in this field if there are some. </td> </tr> </table> <a name="ElementDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Elements' Details</td> </tr> <tr> <td class="imdetail"><a name="HasAutoStart" class="membertitle">HasAutoStart</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>HasAutoStart</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies whether the start value for the grouping is taken automatically from the minimum of the item values. </dd> <dd><p><ul> <li>If <b>false</b> is set, the value from <a href="#Start">Start</a> will be used as start value for the grouping.</li> <li>If <b>true</b> is set, the start value for the grouping will be calculated automatically from the minimum of all member values of the DataPilot field.</li> </ul></p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="HasAutoEnd" class="membertitle">HasAutoEnd</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>HasAutoEnd</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies whether the end value for the grouping is taken automatically from the maximum of the item values. </dd> <dd><p><ul> <li>If <b>false</b> is set, the value from <a href="#End">End</a> will be used as end value for the grouping.</li> <li>If <b>true</b> is set, the end value for the grouping will be calculated automatically from the maximum of all member values of the DataPilot field.</li> </ul></p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="HasDateValues" class="membertitle">HasDateValues</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>HasDateValues</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies whether date values are grouped by ranges of days. </dd> <dd><p><ul> <li>If <b>false</b> is set, and <a href="#GroupBy">GroupBy</a> contains zero, grouping is performed inplace on the item values.</li> <li>If <b>false</b> is set, and <a href="#GroupBy">GroupBy</a> contains one or more flags from <a href="DataPilotFieldGroupBy.html">DataPilotFieldGroupBy</a>, grouping is performed on date or time.</li> <li>If <b>true</b> is set, <a href="#Step">Step</a> contains a value greater than or equal to 1, and <a href="#GroupBy">GroupBy</a> set to <b> DataPilotFieldGroupBy::DAYS</b>, grouping is performed on ranges of days (see descriptions for <a href="XDataPilotFieldGrouping.html">XDataPilotFieldGrouping</a>::<a href="XDataPilotFieldGrouping.html#createDateGroup">createDateGroup</a> for more details about day grouping).</li> </ul></p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Start" class="membertitle">Start</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>double <b>Start</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the start value for the grouping if <a href="#HasAutoStart">HasAutoStart</a> is set to <b>false</b>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="End" class="membertitle">End</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>double <b>End</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the end value for the grouping if <a href="#HasAutoEnd">HasAutoEnd</a> is set to <b>false</b>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Step" class="membertitle">Step</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>double <b>Step</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the size of the ranges for numeric or day grouping. </dd> <dd><p>Example: With <a href="#HasAutoStart">HasAutoStart</a> set to <b>false</b>, <a href="#Start">Start</a> set to 2, and <a href="#Step">Step</a> set to 3, the first group will contain all values greater than or equal to 2 and less than 5. The second group will contain all values greater than or equal to 5 and less then 8, and so on.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="GroupBy" class="membertitle">GroupBy</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>GroupBy</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the grouping of the date values. </dd> <dt><b>See also</b></dt> <dd><a href="DataPilotFieldGroupBy.html">DataPilotFieldGroupBy</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SourceField" class="membertitle">SourceField</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><a href="XDataPilotField.html">XDataPilotField</a> <b>SourceField</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the source DataPilot field grouping is based on. Will be <b>NULL</b> if this field is not grouped or contains numeric grouping. </dd> <dt><b>See also</b></dt> <dd><a href="DataPilotField.html">DataPilotField</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>::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNameAccess.html">XNameAccess</a> <b>Groups</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the named groups in this field if there are some. </dd> <dd><p>The returned object is an instance of <a href="DataPilotFieldGroups.html">DataPilotFieldGroups</a>. The collection of groups can be modified by inserting, removing, replacing, or renaming single groups or item names in the groups. When writing back this struct containing such a changed collection of groups to the <a href="DataPilotField.html">DataPilotField</a>::<a href="DataPilotField.html#GroupInfo">GroupInfo</a> property, the modified grouping settings are applied at the DataPilot field.</p> </dd> <dt><b>See also</b></dt> <dd><a href="DataPilotField.html">DataPilotField</a>, <a href="DataPilotFieldGroups.html">DataPilotFieldGroups</a></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>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
5790
