<html> <head> <title>Interface XDataPilotFieldGrouping</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="XDataPilotFieldGrouping-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="#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 XDataPilotFieldGrouping</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>Provides methods to create new DataPilot fields where some or all items of this DataPilot field are grouped in some way. </dd> <dt><b>See also</b></dt> <dd><a href="DataPilotField.html">DataPilotField</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="#createNameGroup">createNameGroup</a></td> <td class="imsum_right">Creates a new DataPilot field which contains a group containing the given DataPilot field items (members). </td> </tr> <tr> <td class="imsum_left"><a href="#createDateGroup">createDateGroup</a></td> <td class="imsum_right">Groups the members of this field by dates, according to the passed settings. </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="createNameGroup" class="membertitle">createNameGroup</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"><a href="XDataPilotField.html">XDataPilotField</a></td> </tr> <tr> <td valign="top"><b>createNameGroup</b>(</td> <td valign="top">[in] sequence< string ></td> <td valign="bottom"> aItems )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Creates a new DataPilot field which contains a group containing the given DataPilot field items (members). </dd> <dd><p>It is possible to create multiple groups by calling this method several times at the same DataPilot field. On subsequent calls, the DataPilot field created at the first call is used to insert the new groups.</p> <p>The collection of groups can be accessed via the <a href="DataPilotField.html">DataPilotField</a>::<a href="DataPilotField.html#GroupInfo">GroupInfo</a> property. The returned struct contains the sequence of groups in its member <a href="DataPilotFieldGroupInfo.html">DataPilotFieldGroupInfo</a>::<a href="DataPilotFieldGroupInfo.html#Groups">Groups</a>.</p> </dd> <dt><b>Parameter aItems</b></dt> <dd>a sequence containing the names of the items (members) which will be part of the new group. Must be names of items contained in the current field. </dd> <dt><b>Returns</b></dt> <dd>the new created field if there is one created on the first call of this method. <b>NULL</b> is returned on subsequent calls. </dd> <dt><b>See also</b></dt> <dd><a href="DataPilotField.html">DataPilotField</a>, <a href="DataPilotFieldGroupInfo.html">DataPilotFieldGroupInfo</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="createDateGroup" class="membertitle">createDateGroup</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"><a href="XDataPilotField.html">XDataPilotField</a></td> </tr> <tr> <td valign="top"><b>createDateGroup</b>(</td> <td valign="top">[in] <a href="DataPilotFieldGroupInfo.html">DataPilotFieldGroupInfo</a></td> <td valign="bottom"> aInfo )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Groups the members of this field by dates, according to the passed settings. </dd> <dd><p>If this field is already grouped by dates, a new DataPilot field will be created and returned. If this field is not grouped at all, the date grouping is perfomed inside of this field (no new field will be created). There must not be any other grouping (by member names or by numeric ranges), otherwise an exception is thrown.</p> </dd> <dt><b>Parameter aInfo</b></dt> <dd>contains the information how to group the items of the field. The members of this struct have to fulfill the following requirements: <ul> <li>If the member <a href="DataPilotFieldGroupInfo.html">DataPilotFieldGroupInfo</a>::<a href="DataPilotFieldGroupInfo.html#HasAutoStart">HasAutoStart</a> is set to <b>false</b>, then the value of <a href="DataPilotFieldGroupInfo.html">DataPilotFieldGroupInfo</a>::<a href="DataPilotFieldGroupInfo.html#Start">Start</a> must be a floating-point value representing a valid date/time value (if <a href="DataPilotFieldGroupInfo.html">DataPilotFieldGroupInfo</a>::<a href="DataPilotFieldGroupInfo.html#HasAutoStart">HasAutoStart</a> is set to <b>true</b>, the value of <a href="DataPilotFieldGroupInfo.html">DataPilotFieldGroupInfo</a>::<a href="DataPilotFieldGroupInfo.html#Start">Start</a> will be ignored).</li> <li>If the member <a href="DataPilotFieldGroupInfo.html">DataPilotFieldGroupInfo</a>::<a href="DataPilotFieldGroupInfo.html#HasAutoEnd">HasAutoEnd</a> is set to <b>false</b>, then the value of <a href="DataPilotFieldGroupInfo.html">DataPilotFieldGroupInfo</a>::<a href="DataPilotFieldGroupInfo.html#End">End</a> must be a floating-point value representing a valid date/time value( if <a href="DataPilotFieldGroupInfo.html">DataPilotFieldGroupInfo</a>::<a href="DataPilotFieldGroupInfo.html#HasAutoEnd">HasAutoEnd</a> is set to <b>true</b>, the value of <a href="DataPilotFieldGroupInfo.html">DataPilotFieldGroupInfo</a>::<a href="DataPilotFieldGroupInfo.html#End">End</a> will be ignored).</li> <li>If the members <a href="DataPilotFieldGroupInfo.html">DataPilotFieldGroupInfo</a>::<a href="DataPilotFieldGroupInfo.html#HasAutoStart">HasAutoStart</a> and <a href="DataPilotFieldGroupInfo.html">DataPilotFieldGroupInfo</a>::<a href="DataPilotFieldGroupInfo.html#HasAutoEnd">HasAutoEnd</a> are set to <b>false</b> both, then the value of <a href="DataPilotFieldGroupInfo.html">DataPilotFieldGroupInfo</a>::<a href="DataPilotFieldGroupInfo.html#Start">Start</a> must be less than or equal to the value of <a href="DataPilotFieldGroupInfo.html">DataPilotFieldGroupInfo</a>::<a href="DataPilotFieldGroupInfo.html#End">End</a>.</li> <li>The member <a href="DataPilotFieldGroupInfo.html">DataPilotFieldGroupInfo</a>::<a href="DataPilotFieldGroupInfo.html#HasDateValues">HasDateValues</a> must be set to <b>true</b>.</li> <li>The member <a href="DataPilotFieldGroupInfo.html">DataPilotFieldGroupInfo</a>::<a href="DataPilotFieldGroupInfo.html#Step">Step</a> must be zero, unless ranges of days have to be grouped (see the description of the member GroupBy below), in that case the value must be greater than or equal to 1 and less than or equal to 32767. The fractional part of the value will be ignored.</li> <li>The member <a href="DataPilotFieldGroupInfo.html">DataPilotFieldGroupInfo</a>::<a href="DataPilotFieldGroupInfo.html#GroupBy">GroupBy</a> must contain exactly one of the flags from <a href="DataPilotFieldGroupBy.html">DataPilotFieldGroupBy</a>. A combination of several flags will not be accepted. If <b>DataPilotFieldGroupBy::DAYS</b> is specified, the value of the member <a href="DataPilotFieldGroupInfo.html">DataPilotFieldGroupInfo</a>::<a href="DataPilotFieldGroupInfo.html#Step">Step</a> will specify the type of day grouping (see above). If that value is zero, grouping is performed on all days of the year (e.g. the members containing the 1st of January of any year are grouped together). If that value is greater than zero, grouping is done on ranges of days, and the value specifies the number of days grouped into one range (e.g. a value of 7 groups the members of a week into a range).</li> <li>The contents of the member <a href="DataPilotFieldGroupInfo.html">DataPilotFieldGroupInfo</a>::<a href="DataPilotFieldGroupInfo.html#SourceField">SourceField</a> will be ignored.</li> <li>The contents of the member <a href="DataPilotFieldGroupInfo.html">DataPilotFieldGroupInfo</a>::<a href="DataPilotFieldGroupInfo.html#Groups">Groups</a> will be ignored.</li> </ul> </dd> <dt><b>Returns</b></dt> <dd>the new created field if there is one created. <b>NULL</b> is returned, if date grouping is performed inside this field (i.e. this field was not grouped by dates before). </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if the passed struct does not contain valid settings as described, or if this field is already grouped by member names or numeric ranges. </dd> <dt><b>See also</b></dt> <dd><a href="DataPilotField.html">DataPilotField</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
>
6115
