<html> <head> <title>Interface XReportComponent</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="XReportComponent-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">Methods' Summary</td> <td class="navisub"><a href="#AttributesSummary" class="navisub">Attributes' Summary</a></td> <td class="navisub">Methods' Details</td> <td class="navisub"><a href="#AttributesDetails" class="navisub">Attributes' 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">report</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 XReportComponent</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XReportComponent</strong> ┣ ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XCloneable.html">XCloneable</a> ┣ ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XChild.html">XChild</a> ┣ ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a> ┣ ::com::sun::star::<a href="../drawing/module-ix.html">drawing</a>::<a href="../drawing/XShape.html">XShape</a> ┃ ┗ ::com::sun::star::<a href="../drawing/module-ix.html">drawing</a>::<a href="../drawing/XShapeDescriptor.html">XShapeDescriptor</a> ┗ ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</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="../util/module-ix.html">util</a>::<a href="../util/XCloneable.html">XCloneable</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>makes it possible to create a copy of the object which supports this interface. </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XChild.html">XChild</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>identifies the component as a candidate for being part of a report. </dd> <dd><p>This interface also provides the access to the component's parent.</p> </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows life-time control of report components. </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../drawing/module-ix.html">drawing</a>::<a href="../drawing/XShape.html">XShape</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>lets you do a basic transformation on a ::com::sun::star::<a href="../drawing/module-ix.html">drawing</a>::<a href="../drawing/Shape.html">Shape</a> and get its type. </dd> </dl> </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"><dl> <dt><b>Description</b></dt> <dd>gives access to the properties. </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>describes a component which may be part of a report. </dd> <dt><b>See also</b></dt> <dd><a href="XReportDefinition.html">XReportDefinition</a></dd> </dl> </td> </tr> </table> <hr> <a name="AttributesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Attributes' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#Name">Name</a></td> <td class="imsum_right">the name of the component. </td> </tr> <tr> <td class="imsum_left"><a href="#Height">Height</a></td> <td class="imsum_right">specifies the height of the control. </td> </tr> <tr> <td class="imsum_left"><a href="#PositionX">PositionX</a></td> <td class="imsum_right">specifies the horizontal position of the control. </td> </tr> <tr> <td class="imsum_left"><a href="#PositionY">PositionY</a></td> <td class="imsum_right">specifies the vertical position of the control. </td> </tr> <tr> <td class="imsum_left"><a href="#Width">Width</a></td> <td class="imsum_right">specifies the width of the control. </td> </tr> <tr> <td class="imsum_left"><a href="#ControlBorder">ControlBorder</a></td> <td class="imsum_right">specifies the border style of the control. </td> </tr> <tr> <td class="imsum_left"><a href="#ControlBorderColor">ControlBorderColor</a></td> <td class="imsum_right">specifies the color of the border, if present </td> </tr> <tr> <td class="imsum_left"><a href="#PrintRepeatedValues">PrintRepeatedValues</a></td> <td class="imsum_right">Specifies that recurring values are printed. If set to <b>true</b> then the value will be printed every time. If set to <b>false</b> then the value will only be printed once. The default value is <b>true</b>. </td> </tr> <tr> <td class="imsum_left"><a href="#MasterFields">MasterFields</a></td> <td class="imsum_right">is used for subreports and contains the names of columns of the parent report. </td> </tr> <tr> <td class="imsum_left"><a href="#DetailFields">DetailFields</a></td> <td class="imsum_right">is used for subreports and contains the names of the columns of the subreport which are related to the master fields of the parent report. </td> </tr> <tr> <td class="imsum_left"><a href="#Section">Section</a></td> <td class="imsum_right">Specifies the section where the control belongs to. This is a shortcut to get control hierachy up. This value is <b>NULL</b> when the control was not inserted in any section. </td> </tr> </table> <a name="AttributesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Attributes' Details</td> </tr> <tr> <td class="imdetail"><a name="Name" class="membertitle">Name</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] string <b>Name</b><dl> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyVetoException.html">PropertyVetoException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>the name of the component. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Height" class="membertitle">Height</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] long <b>Height</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the height of the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="PositionX" class="membertitle">PositionX</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] long <b>PositionX</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the horizontal position of the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="PositionY" class="membertitle">PositionY</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] long <b>PositionY</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the vertical position of the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Width" class="membertitle">Width</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] long <b>Width</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the width of the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ControlBorder" class="membertitle">ControlBorder</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] short <b>ControlBorder</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>specifies the border style of the control. </dd> <dd><pre> 0: No border 2: simple border </pre> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ControlBorderColor" class="membertitle">ControlBorderColor</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] long <b>ControlBorderColor</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>specifies the color of the border, if present </dd> <dd><p>Not every border style (see <a href="#Border">Border</a>) may support coloring. For instance, usually a border with 3D effect will ignore the BorderColor setting.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="PrintRepeatedValues" class="membertitle">PrintRepeatedValues</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] boolean <b>PrintRepeatedValues</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>Specifies that recurring values are printed. If set to <b>true</b> then the value will be printed every time. If set to <b>false</b> then the value will only be printed once. The default value is <b>true</b>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="MasterFields" class="membertitle">MasterFields</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] sequence< string > <b>MasterFields</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>is used for subreports and contains the names of columns of the parent report. </dd> <dd><p> These columns are typically the foreign key fields of the parent report. The values of theses columns are used to identify the data for the subreport. Each time the parent report changes it's current row, the subreport requeries it's data based on the values of the master fields.</p> <p>If the report is no sub report (e.g. it's parent is not a report itself), this property is not evaluated.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="DetailFields" class="membertitle">DetailFields</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] sequence< string > <b>DetailFields</b><dl> <dd>get raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>)</dd> <dd>set raises (::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>is used for subreports and contains the names of the columns of the subreport which are related to the master fields of the parent report. </dd> <dd><p>Entries in this sequence can either denote column names in the sub report, or paramater names.<br/> For instance, you could base the report on the SQL statement <code>SELECT * FROM invoices WHERE cust_ref = :cid</code>, and add <code>cid</code> to the DetailFields property. In this case, the parameter will be filled from the corresponding master field.<br/> Alternatively, you could simply base your report on the table <code>invoices</code>, and add the column name <code>cust_ref</code> to the DetailFields. In this case, and implicit filter clause <code>WHERE cust_ref = :<new_param_name></code> will be created, and the artificial parameter will be filled from the corresponding master field.<br/> If a string in this property denotes both a column name and a parameter name, it is undefined which way it is interpreted, but implementations of the service are required to either decide for the paramter or the column, and proceed as usual. </p> <p>The columns specified herein typically represent a part of the primary key fields or their aliases of the detail report.</p> <p>If the report is no sub report (e.g. it's parent is not a report itself), this property is not evaluated.</p> * </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Section" class="membertitle">Section</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] <a href="XSection.html">XSection</a> <b>Section</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Specifies the section where the control belongs to. This is a shortcut to get control hierachy up. This value is <b>NULL</b> when the control was not inserted in any section. </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
>
4908
