Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > fc480f9d5aabed8eeaffe8ad3401a94c > files > 6123

openoffice.org-devel-doc-3.2.1-0.3mdv2010.2.i586.rpm

<html>
<head>
<title>Interface XDataPilotTable2</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="XDataPilotTable2-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"><table class="title-table" width="99%">
<tr>
<td width="25%" class="title2">unpublished </td>
<td width="50%" class="title">interface XDataPilotTable2</td>
<td width="*"/></tr>
</table>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Base Interfaces</b></dt>
<dd><pre style="font-family:monospace;"><strong>XDataPilotTable2</strong>
&#x2517 <a href="XDataPilotTable.html">XDataPilotTable</a>

</pre></dd>
<dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle">
<tr>
<td class="imsum_left"><a href="XDataPilotTable.html">XDataPilotTable</a></td>
<td class="imsum_right"><dl>
<dt>(referenced interface's summary:)</dt>
<dd>provides methods to control a data pilot table which has already
 been created.

 </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>additional methods to extend <a href="XDataPilotTable.html">XDataPilotTable</a>. 

 <a href="XDataPilotTable2.html">XDataPilotTable2</a> extends the old 
 <a href="XDataPilotTable.html">XDataPilotTable</a> interface with 
 additional methods.

 </dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 3.0.0</dd>
<dt><b>See also</b></dt>
<dd><a href="XDataPilotTable.html">XDataPilotTable</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="#getDrillDownData">getDrillDownData</a></td>
<td class="imsum_right">When the address of a cell within the result area is given, 
 <method>XDataPilotTable2::getDrillDownData</method> returns its drill-down 
 output table that includes only those rows that contribute to the value of
 that cell.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getPositionData">getPositionData</a></td>
<td class="imsum_right">Given a cell address, it returns the information about that cell. The 
 type of information returned depends upon whether the cell is within 
 the result area or column/row header area.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#insertDrillDownSheet">insertDrillDownSheet</a></td>
<td class="imsum_right">&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getOutputRangeByType">getOutputRangeByType</a></td>
<td class="imsum_right">&nbsp;</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="getDrillDownData" class="membertitle">getDrillDownData</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">sequence&lt; sequence&lt; any &gt; &gt;</td>
</tr>
<tr>
<td valign="top"><b>getDrillDownData</b>(</td>
<td valign="top">[in] ::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/CellAddress.html">CellAddress</a></td>
<td valign="bottom">&nbsp;aAddr );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>When the address of a cell within the result area is given, 
 <method>XDataPilotTable2::getDrillDownData</method> returns its drill-down 
 output table that includes only those rows that contribute to the value of
 that cell.

 </dd>
<dt><b>Parameter aAddr</b></dt>
<dd>cell address within the result area of a DataPilot table.

 </dd>
<dt><b>Returns</b></dt>
<dd>drill-down output as 2-dimensional sequence, including the header row.

 </dd>
<dt><b>See also</b></dt>
<dd><a href="#? (no identifier found)">? (no identifier found)</a><br>
XDataPilotTable2::insertDrillDownSheet</method>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getPositionData" class="membertitle">getPositionData</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="DataPilotTablePositionData.html">DataPilotTablePositionData</a></td>
</tr>
<tr>
<td valign="top"><b>getPositionData</b>(</td>
<td valign="top">[in] ::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/CellAddress.html">CellAddress</a></td>
<td valign="bottom">&nbsp;aAddr );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Given a cell address, it returns the information about that cell. The 
 type of information returned depends upon whether the cell is within 
 the result area or column/row header area.

 </dd>
<dt><b>Parameter aAddr</b></dt>
<dd>address of the cell whose information is to be returned.

 </dd>
<dt><b>Returns</b></dt>
<dd><a href="DataPilotTablePositionData.html">DataPilotTablePositionData</a> which contains the 
 position type and the information for that cell position.

 </dd>
<dt><b>See also</b></dt>
<dd><a href="DataPilotTablePositionData.html">DataPilotTablePositionData</a>, <a href="DataPilotTableHeaderData.html">DataPilotTableHeaderData</a>, <a href="DataPilotTableResultData.html">DataPilotTableResultData</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="insertDrillDownSheet" class="membertitle">insertDrillDownSheet</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>insertDrillDownSheet</b>(</td>
<td valign="top">[in] ::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/CellAddress.html">CellAddress</a></td>
<td valign="bottom">&nbsp;aAddr );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd><p>This method inserts a new sheet to display the drill-down data for a 
 specified result cell. A drill-down data for a result cell consists 
 of a subset of rows from the original data source that contribute to 
 the value displayed in that cell.</p>

 <p>The new sheet is always inserted to the immediate left of the current
 sheet where the DataPilot table is. Note that when the drill-down data
 is empty, no new sheet is inserted.</p>

 </dd>
<dt><b>Parameter aAddr</b></dt>
<dd>address of a result cell

 </dd>
<dt><b>Returns</b></dt>
<dd><b>void</b>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getOutputRangeByType" class="membertitle">getOutputRangeByType</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">::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/CellRangeAddress.html">CellRangeAddress</a></td>
</tr>
<tr>
<td valign="top"><b>getOutputRangeByType</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nType )</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><p>This method returns a different output range of a DataPilot table 
 per specified output range type.</p>

 </dd>
<dt><b>Returns</b></dt>
<dd>::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/CellRangeAddress.html">CellRangeAddress</a> depicting
 the range specified. See <a href="DataPilotOutputRangeType.html">DataPilotOutputRangeType</a> for a set
 of possible output range types.

 </dd>
<dt><b>See also</b></dt>
<dd><a href="DataPilotOutputRangeType.html">DataPilotOutputRangeType</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 &copy; 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>