<html> <head> <title>Interface XDataPilotDescriptor</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="XDataPilotDescriptor-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 XDataPilotDescriptor</td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XDataPilotDescriptor</strong> ┗ ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNamed.html">XNamed</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/XNamed.html">XNamed</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>specifies the name of the object. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>provides access to the layout settings of a data pilot table. </dd> <dd><p>This interface extends the interface ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNamed.html">XNamed</a> which provides access to the name of the data pilot table used e.g. in collections.</p> </dd> <dt><b>See also</b></dt> <dd><a href="DataPilotDescriptor.html">DataPilotDescriptor</a>, <a href="DataPilotTable.html">DataPilotTable</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="#getTag">getTag</a></td> <td class="imsum_right">returns an additional string stored in the data pilot table. </td> </tr> <tr> <td class="imsum_left"><a href="#setTag">setTag</a></td> <td class="imsum_right">sets an additional string stored in the data pilot table. </td> </tr> <tr> <td class="imsum_left"><a href="#getSourceRange">getSourceRange</a></td> <td class="imsum_right">returns the cell range containing the data for the data pilot table. </td> </tr> <tr> <td class="imsum_left"><a href="#setSourceRange">setSourceRange</a></td> <td class="imsum_right">sets the cell range containing the data for the data pilot table. </td> </tr> <tr> <td class="imsum_left"><a href="#getFilterDescriptor">getFilterDescriptor</a></td> <td class="imsum_right">returns the filter descriptor specifying which data from the source cell range are used for the data pilot table. </td> </tr> <tr> <td class="imsum_left"><a href="#getDataPilotFields">getDataPilotFields</a></td> <td class="imsum_right">returns the collection of all the data pilot fields. </td> </tr> <tr> <td class="imsum_left"><a href="#getColumnFields">getColumnFields</a></td> <td class="imsum_right">returns the collection of the data pilot fields used as column fields. </td> </tr> <tr> <td class="imsum_left"><a href="#getRowFields">getRowFields</a></td> <td class="imsum_right">returns the collection of the data pilot fields used as row fields. </td> </tr> <tr> <td class="imsum_left"><a href="#getPageFields">getPageFields</a></td> <td class="imsum_right">returns the collection of the data pilot fields used as page fields. </td> </tr> <tr> <td class="imsum_left"><a href="#getDataFields">getDataFields</a></td> <td class="imsum_right">returns the collection of the data pilot fields used as data fields. </td> </tr> <tr> <td class="imsum_left"><a href="#getHiddenFields">getHiddenFields</a></td> <td class="imsum_right">returns the collection of the data pilot fields not used as column, row, page, or data fields. </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="getTag" class="membertitle">getTag</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">string</td> </tr> <tr> <td valign="top"><b>getTag</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns an additional string stored in the data pilot table. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setTag" class="membertitle">setTag</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>setTag</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aTag );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets an additional string stored in the data pilot table. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getSourceRange" class="membertitle">getSourceRange</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>getSourceRange</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the cell range containing the data for the data pilot table. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setSourceRange" class="membertitle">setSourceRange</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>setSourceRange</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../table/module-ix.html">table</a>::<a href="../table/CellRangeAddress.html">CellRangeAddress</a></td> <td valign="bottom"> aSourceRange );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the cell range containing the data for the data pilot table. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getFilterDescriptor" class="membertitle">getFilterDescriptor</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="XSheetFilterDescriptor.html">XSheetFilterDescriptor</a></td> </tr> <tr> <td valign="top"><b>getFilterDescriptor</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the filter descriptor specifying which data from the source cell range are used for the data pilot table. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDataPilotFields" class="membertitle">getDataPilotFields</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="../container/module-ix.html">container</a>::<a href="../container/XIndexAccess.html">XIndexAccess</a></td> </tr> <tr> <td valign="top"><b>getDataPilotFields</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the collection of all the data pilot fields. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getColumnFields" class="membertitle">getColumnFields</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="../container/module-ix.html">container</a>::<a href="../container/XIndexAccess.html">XIndexAccess</a></td> </tr> <tr> <td valign="top"><b>getColumnFields</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the collection of the data pilot fields used as column fields. </dd> <dt><b>See also</b></dt> <dd><a href="DataPilotFields.html">DataPilotFields</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getRowFields" class="membertitle">getRowFields</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="../container/module-ix.html">container</a>::<a href="../container/XIndexAccess.html">XIndexAccess</a></td> </tr> <tr> <td valign="top"><b>getRowFields</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the collection of the data pilot fields used as row fields. </dd> <dt><b>See also</b></dt> <dd><a href="DataPilotFields.html">DataPilotFields</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getPageFields" class="membertitle">getPageFields</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="../container/module-ix.html">container</a>::<a href="../container/XIndexAccess.html">XIndexAccess</a></td> </tr> <tr> <td valign="top"><b>getPageFields</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the collection of the data pilot fields used as page fields. </dd> <dt><b>See also</b></dt> <dd><a href="DataPilotFields.html">DataPilotFields</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDataFields" class="membertitle">getDataFields</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="../container/module-ix.html">container</a>::<a href="../container/XIndexAccess.html">XIndexAccess</a></td> </tr> <tr> <td valign="top"><b>getDataFields</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the collection of the data pilot fields used as data fields. </dd> <dt><b>See also</b></dt> <dd><a href="DataPilotFields.html">DataPilotFields</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getHiddenFields" class="membertitle">getHiddenFields</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="../container/module-ix.html">container</a>::<a href="../container/XIndexAccess.html">XIndexAccess</a></td> </tr> <tr> <td valign="top"><b>getHiddenFields</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the collection of the data pilot fields not used as column, row, page, or data fields. </dd> <dt><b>See also</b></dt> <dd><a href="DataPilotFields.html">DataPilotFields</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>