<html> <head> <title>Service DataPilotField</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="DataPilotField-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Spreadsheets/Creating_a_New_DataPilot_Table" 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 DataPilotField</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>represents a single field in a data pilot table. </dd> <dd><p>If the data pilot table is based on a spreadsheet cell range, a field is representred by a column of the range and is named using the topmost cell of the column.</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/Creating_a_New_DataPilot_Table">Spreadsheets - Creating a New DataPilot Table</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">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNamed.html">XNamed</a></td> <td class="imsum_right"><p>provides access to the name of the data pilot field. </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> <tr> <td class="imsum_left"><a href="XDataPilotField.html">XDataPilotField</a></td> <td class="imsum_right"/></tr> <tr> <td class="imsum_left"><a href="XDataPilotFieldGrouping.html">XDataPilotFieldGrouping</a></td> <td class="imsum_right"/></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"><a href="DataPilotFieldOrientation.html">DataPilotFieldOrientation</a><br> <a href="#Orientation">Orientation</a></td> <td class="imsum_right">specifies the orientation of the field. </td> </tr> <tr> <td class="imsum_left"><a href="GeneralFunction.html">GeneralFunction</a><br> <a href="#Function">Function</a></td> <td class="imsum_right">specifies the function used to calculate results for this field. </td> </tr> <tr> <td class="imsum_left">sequence< <a href="GeneralFunction.html">GeneralFunction</a> ><br> <a href="#Subtotals">Subtotals</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies the functions used to calculate subtotals for this field. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#SelectedPage">SelectedPage</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies the selected page which is used to filter the data pilot. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#UseSelectedPage">UseSelectedPage</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies whether to use the selected page to filter the data pilot or show all. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#UsedHierarchy">UsedHierarchy</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies which hierarchy of the dimension is used. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#HasSortInfo">HasSortInfo</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies whether this field has sorting information. </td> </tr> <tr> <td class="imsum_left"><a href="DataPilotFieldSortInfo.html">DataPilotFieldSortInfo</a><br> <a href="#SortInfo">SortInfo</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>controls how the field's items are sorted. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#HasLayoutInfo">HasLayoutInfo</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies whether this field has layout information. </td> </tr> <tr> <td class="imsum_left"><a href="DataPilotFieldLayoutInfo.html">DataPilotFieldLayoutInfo</a><br> <a href="#LayoutInfo">LayoutInfo</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>controls how the field's items are laid out in the result table. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#HasAutoShowInfo">HasAutoShowInfo</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies whether this field has auto show information. </td> </tr> <tr> <td class="imsum_left"><a href="DataPilotFieldAutoShowInfo.html">DataPilotFieldAutoShowInfo</a><br> <a href="#AutoShowInfo">AutoShowInfo</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>enables the automatic inclusion of only a number of items with the highest or lowest result values. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#HasReference">HasReference</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies whether this field has a reference. </td> </tr> <tr> <td class="imsum_left"><a href="DataPilotFieldReference.html">DataPilotFieldReference</a><br> <a href="#Reference">Reference</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>controls how the results are shown in relation to a selected reference result. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#IsGroupField">IsGroupField</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies whether this field is a group field. </td> </tr> <tr> <td class="imsum_left"><a href="DataPilotFieldGroupInfo.html">DataPilotFieldGroupInfo</a><br> <a href="#GroupInfo">GroupInfo</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>contains the grouping information of the DataPilot field. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#ShowEmpty">ShowEmpty</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies whether to show this field also if it is empty or not. </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="XNamed" class="membertitle">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNamed.html">XNamed</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 name of the data pilot field. </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> <tr/> <tr> <td class="imdetail"><a name="XDataPilotField" class="membertitle"><a href="XDataPilotField.html">XDataPilotField</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XDataPilotFieldGrouping" class="membertitle"><a href="XDataPilotFieldGrouping.html">XDataPilotFieldGrouping</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></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="Orientation" class="membertitle">Orientation</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><a href="DataPilotFieldOrientation.html">DataPilotFieldOrientation</a> <b>Orientation</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the orientation of the field. </dd> <dd><p>If the orientation of a field has been changed using this property, the field will be moved to the last position in the collection of all fields with the specified orientation.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Function" class="membertitle">Function</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><a href="GeneralFunction.html">GeneralFunction</a> <b>Function</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the function used to calculate results for this field. </dd> <dd><p>For column and row fields, this is the function for subtotals (<b>GeneralFunction::NONE</b> means no subtotals). For data fields, this is the function shown in the data pilot table.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Subtotals" class="membertitle">Subtotals</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>sequence< <a href="GeneralFunction.html">GeneralFunction</a> > <b>Subtotals</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies the functions used to calculate subtotals for this field. </dd> <dd><p>This property is supported by column and row fields only.</p> <p>An empty sequence means no subtotals. The same effect can be achieved by setting the property <a href="#Function">Function</a> to the value <b>GeneralFunction::NONE</b>. If the length of the sequence is greater then 1, then the sequence MUST NOT contain one of the values <b>GeneralFunction::NONE</b> or <b>GeneralFunction::AUTO</b>.</p> <p>The order of the functions in this sequence is reflected in the DataPilot table. Multiple entries of the same function are ignored when setting the property.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SelectedPage" class="membertitle">SelectedPage</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>SelectedPage</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies the selected page which is used to filter the data pilot. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="UseSelectedPage" class="membertitle">UseSelectedPage</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>UseSelectedPage</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies whether to use the selected page to filter the data pilot or show all. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="UsedHierarchy" class="membertitle">UsedHierarchy</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>UsedHierarchy</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies which hierarchy of the dimension is used. </dd> <dt><b>See also</b></dt> <dd><a href="DataPilotSourceHierarchies.html">DataPilotSourceHierarchies</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="HasSortInfo" class="membertitle">HasSortInfo</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>HasSortInfo</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies whether this field has sorting information. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="SortInfo" class="membertitle">SortInfo</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><a href="DataPilotFieldSortInfo.html">DataPilotFieldSortInfo</a> <b>SortInfo</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>controls how the field's items are sorted. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="HasLayoutInfo" class="membertitle">HasLayoutInfo</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>HasLayoutInfo</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies whether this field has layout information. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="LayoutInfo" class="membertitle">LayoutInfo</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><a href="DataPilotFieldLayoutInfo.html">DataPilotFieldLayoutInfo</a> <b>LayoutInfo</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>controls how the field's items are laid out in the result table. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="HasAutoShowInfo" class="membertitle">HasAutoShowInfo</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>HasAutoShowInfo</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies whether this field has auto show information. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="AutoShowInfo" class="membertitle">AutoShowInfo</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><a href="DataPilotFieldAutoShowInfo.html">DataPilotFieldAutoShowInfo</a> <b>AutoShowInfo</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>enables the automatic inclusion of only a number of items with the highest or lowest result values. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="HasReference" class="membertitle">HasReference</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>HasReference</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies whether this field has a reference. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Reference" class="membertitle">Reference</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><a href="DataPilotFieldReference.html">DataPilotFieldReference</a> <b>Reference</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>controls how the results are shown in relation to a selected reference result. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="IsGroupField" class="membertitle">IsGroupField</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>IsGroupField</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies whether this field is a group field. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="GroupInfo" class="membertitle">GroupInfo</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><a href="DataPilotFieldGroupInfo.html">DataPilotFieldGroupInfo</a> <b>GroupInfo</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>contains the grouping information of the DataPilot field. </dd> <dd><p>By changing the value of this property it is possible to modify the grouping settings of this field.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ShowEmpty" class="membertitle">ShowEmpty</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>ShowEmpty</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies whether to show this field also if it is empty or not. </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 © 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
>
5779
