<html> <head> <title>Interface XReportDefinition</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="XReportDefinition-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"><a href="#AttributesSummary" class="navisub">Attributes' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></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 XReportDefinition</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XReportDefinition</strong> ┣ ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XModel.html">XModel</a> ┃ ┗ ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a> ┣ ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XLoadable.html">XLoadable</a> ┣ ::com::sun::star::<a href="../embed/module-ix.html">embed</a>::<a href="../embed/XVisualObject.html">XVisualObject</a> ┣ ::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/XStorageBasedDocument.html">XStorageBasedDocument</a> ┣ ::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/XViewDataSupplier.html">XViewDataSupplier</a> ┣ ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XCloseable.html">XCloseable</a> ┃ ┗ ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XCloseBroadcaster.html">XCloseBroadcaster</a> ┣ ::com::sun::star::<a href="../ui/module-ix.html">ui</a>::<a href="../ui/XUIConfigurationManagerSupplier.html">XUIConfigurationManagerSupplier</a> ┣ ::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/XDocumentSubStorageSupplier.html">XDocumentSubStorageSupplier</a> ┣ ::com::sun::star::<a href="../style/module-ix.html">style</a>::<a href="../style/XStyleFamiliesSupplier.html">XStyleFamiliesSupplier</a> ┣ ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XModifiable2.html">XModifiable2</a> ┃ ┗ ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XModifiable.html">XModifiable</a> ┃ ┗ ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XModifyBroadcaster.html">XModifyBroadcaster</a> ┣ <a href="XReportComponent.html">XReportComponent</a> ┃ ┣ ::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> ┗ <a href="XFunctionsSupplier.html">XFunctionsSupplier</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="../frame/module-ix.html">frame</a>::<a href="../frame/XModel.html">XModel</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows the access to the model embedded in the database storage. </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XLoadable.html">XLoadable</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>offers a simple way to initialize a component. </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../embed/module-ix.html">embed</a>::<a href="../embed/XVisualObject.html">XVisualObject</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>represents common visualization functionality for the embedded report. </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/XStorageBasedDocument.html">XStorageBasedDocument</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows to initialize the document with a storage. </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/XViewDataSupplier.html">XViewDataSupplier</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>gives access to some properties describing all open views to a document. </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XCloseable.html">XCloseable</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows to close the document. </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../ui/module-ix.html">ui</a>::<a href="../ui/XUIConfigurationManagerSupplier.html">XUIConfigurationManagerSupplier</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows to retrieve the user interface configuration manager related to an object. </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/XDocumentSubStorageSupplier.html">XDocumentSubStorageSupplier</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>through this interface documents can provide access to their substorages </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../style/module-ix.html">style</a>::<a href="../style/XStyleFamiliesSupplier.html">XStyleFamiliesSupplier</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>provides access to the collection of style families. </dd> <dd><p>A spreadsheet document contains 2 families of styles: "PageStyles" and "CellStyles".</p> </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XModifiable2.html">XModifiable2</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>a storable document should provide information about his modify state </dd> <dd><p> With this interface it's possible too, to reset the modify state. That can be necessary to prevent code against problem during closing of the document without saving any changes. </p> </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XReportComponent.html">XReportComponent</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows the creation of sub reports. </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XFunctionsSupplier.html">XFunctionsSupplier</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>gives access to functions defined in the report definition. </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>identifies a <a href="XReportComponent.html">XReportComponent</a> as being a (sub-) report. </dd> <dd><p>This interface does not really provide an own functionality, it is only for easier runtime identification of report components.</p> <p>A report fulfills several tasks, like storing the structure of its report components and it provides the event environment for its contained elements.</p> </dd> <dt><b>See also</b></dt> <dd><a href="XReportComponent.html">XReportComponent</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="#getEventBroadcaster">getEventBroadcaster</a></td> <td class="imsum_right">makes it possible to register listeners which are called whenever a document event occurs. This is a workaround due to the fact that this interface can not be directly inherited from ::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/XEventBroadcaster.html">XEventBroadcaster</a> because the methods addEventListener and removeEventListener are already defined in ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a>. A queryInterface call is still supported to the ::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/XEventBroadcaster.html">XEventBroadcaster</a> interface. </td> </tr> <tr> <td class="imsum_left"><a href="#getAvailableMimeTypes">getAvailableMimeTypes</a></td> <td class="imsum_right">returns a sequence of the currently supported output formats. </td> </tr> </table> <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="#MimeType">MimeType</a></td> <td class="imsum_right">Represents the output format (media (mime) type) of the resulting document when executing this report. </td> </tr> <tr> <td class="imsum_left"><a href="#Caption">Caption</a></td> <td class="imsum_right">Represents the title of the report in print preview. </td> </tr> <tr> <td class="imsum_left"><a href="#GroupKeepTogether">GroupKeepTogether</a></td> <td class="imsum_right">Specifies whether groups in a multi column report are kept together. </td> </tr> <tr> <td class="imsum_left"><a href="#PageHeaderOption">PageHeaderOption</a></td> <td class="imsum_right">Represents the location of the page header. </td> </tr> <tr> <td class="imsum_left"><a href="#PageFooterOption">PageFooterOption</a></td> <td class="imsum_right">Represents the location of the page footer. </td> </tr> <tr> <td class="imsum_left"><a href="#Command">Command</a></td> <td class="imsum_right">is the command which should be executed, the type of command depends on the CommandType. </td> </tr> <tr> <td class="imsum_left"><a href="#CommandType">CommandType</a></td> <td class="imsum_right">specifies the type of the command to be executed to retrieve a result set. </td> </tr> <tr> <td class="imsum_left"><a href="#Filter">Filter</a></td> <td class="imsum_right">specifies an additional filter to optionally use. </td> </tr> <tr> <td class="imsum_left"><a href="#EscapeProcessing">EscapeProcessing</a></td> <td class="imsum_right">specifies if the <a href="#Command">Command</a> should be analyzed on the client side before sending it to the database server. </td> </tr> <tr> <td class="imsum_left"><a href="#ActiveConnection">ActiveConnection</a></td> <td class="imsum_right">specifies the active connection which is used to create the resulting report. </td> </tr> <tr> <td class="imsum_left"><a href="#DataSourceName">DataSourceName</a></td> <td class="imsum_right">is the name of the datasource to use, this could be a named datasource or the URL of a data access component. </td> </tr> <tr> <td class="imsum_left"><a href="#ReportHeaderOn">ReportHeaderOn</a></td> <td class="imsum_right">Defines that the report header is on. Default is <b>false</b>. </td> </tr> <tr> <td class="imsum_left"><a href="#ReportFooterOn">ReportFooterOn</a></td> <td class="imsum_right">Defines that the report footer is on. Default is <b>false</b>. </td> </tr> <tr> <td class="imsum_left"><a href="#PageHeaderOn">PageHeaderOn</a></td> <td class="imsum_right">Defines that the page header is on. Default is <b>true</b>. </td> </tr> <tr> <td class="imsum_left"><a href="#PageFooterOn">PageFooterOn</a></td> <td class="imsum_right">Defines that the page footer is on. Default is <b>true</b>. </td> </tr> <tr> <td class="imsum_left"><a href="#Groups">Groups</a></td> <td class="imsum_right">Represents the groups of the report. </td> </tr> <tr> <td class="imsum_left"><a href="#ReportHeader">ReportHeader</a></td> <td class="imsum_right">returns the report header if the <a href="#ReportHeaderOn">ReportHeaderOn</a>is <b>true</b>. </td> </tr> <tr> <td class="imsum_left"><a href="#PageHeader">PageHeader</a></td> <td class="imsum_right">returns the page header if the <a href="#PageHeaderOn">PageHeaderOn</a>is <b>true</b>. </td> </tr> <tr> <td class="imsum_left"><a href="#Detail">Detail</a></td> <td class="imsum_right">returns the detail section. </td> </tr> <tr> <td class="imsum_left"><a href="#PageFooter">PageFooter</a></td> <td class="imsum_right">returns the page footer if the <a href="#PageFooterOn">PageFooterOn</a>is <b>true</b>. </td> </tr> <tr> <td class="imsum_left"><a href="#ReportFooter">ReportFooter</a></td> <td class="imsum_right">returns the report footer if the <a href="#ReportFooterOn">ReportFooterOn</a>is <b>true</b>. </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="getEventBroadcaster" class="membertitle">getEventBroadcaster</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="../document/module-ix.html">document</a>::<a href="../document/XEventBroadcaster.html">XEventBroadcaster</a></td> </tr> <tr> <td valign="top"><b>getEventBroadcaster</b>()</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/DisposedException.html">DisposedException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>makes it possible to register listeners which are called whenever a document event occurs. This is a workaround due to the fact that this interface can not be directly inherited from ::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/XEventBroadcaster.html">XEventBroadcaster</a> because the methods addEventListener and removeEventListener are already defined in ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a>. A queryInterface call is still supported to the ::com::sun::star::<a href="../document/module-ix.html">document</a>::<a href="../document/XEventBroadcaster.html">XEventBroadcaster</a> interface. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAvailableMimeTypes" class="membertitle">getAvailableMimeTypes</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< string ></td> </tr> <tr> <td valign="top"><b>getAvailableMimeTypes</b>()</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/DisposedException.html">DisposedException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns a sequence of the currently supported output formats. </dd> </dl> </td> </tr> </table> </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="MimeType" class="membertitle">MimeType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] string <b>MimeType</b><dl> <dd>set raises (::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>Represents the output format (media (mime) type) of the resulting document when executing this report. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Caption" class="membertitle">Caption</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] string <b>Caption</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Represents the title of the report in print preview. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="GroupKeepTogether" class="membertitle">GroupKeepTogether</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] short <b>GroupKeepTogether</b><dl> <dd>set raises (::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>Specifies whether groups in a multi column report are kept together. </dd> <dt><b>See also</b></dt> <dd><a href="#com.sun.star.report.GroupKeepTogether">com.sun.star.report.GroupKeepTogether</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="PageHeaderOption" class="membertitle">PageHeaderOption</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] short <b>PageHeaderOption</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Represents the location of the page header. </dd> <dt><b>See also</b></dt> <dd><a href="ReportPrintOption.html">ReportPrintOption</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="PageFooterOption" class="membertitle">PageFooterOption</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] short <b>PageFooterOption</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Represents the location of the page footer. </dd> <dt><b>See also</b></dt> <dd><a href="ReportPrintOption.html">ReportPrintOption</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Command" class="membertitle">Command</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] string <b>Command</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>is the command which should be executed, the type of command depends on the CommandType. </dd> <dd><p>In case of a <a href="#CommandType">CommandType</a> of ::CommandType::COMMAND, means in case the <a href="#Command">Command</a> specifies an SQL statement, the inherited ::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/RowSet.html">RowSet</a>::<a href="../sdbc/RowSet.html#EscapeProcessing">EscapeProcessing</a> becomes relevant:<br/> It then can be to used to specify whether the SQL statement should be analyzed on the client side before sending it to the database server.<br/> The default value for ::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/RowSet.html">RowSet</a>::<a href="../sdbc/RowSet.html#EscapeProcessing">EscapeProcessing</a> is <b>true</b>. By switching it to <b>false</b>, you can pass backend-specific SQL statements, which are not standard SQL, to your database.</p> </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../sdb/module-ix.html">sdb</a>::<a href="../sdb/CommandType.html">CommandType</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CommandType" class="membertitle">CommandType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] long <b>CommandType</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the type of the command to be executed to retrieve a result set. </dd> <dd><p><a href="#Command">Command</a> needs to be interpreted depending on the value of this property.</p> <p>This property is only meaningful together with the <a href="#Command">Command</a> property, thus either <em>both</em> or <em>none</em> of them are present.</p> </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../sdb/module-ix.html">sdb</a>::<a href="../sdb/CommandType.html">CommandType</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Filter" class="membertitle">Filter</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] string <b>Filter</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies an additional filter to optionally use. </dd> <dd><p>The Filter string has to form a SQL WHERE-clause, <em>without</em> the WHERE-string itself.</p> <p>If a <a href="#DataSourceName">DataSourceName</a>, <a href="#Command">Command</a> and <a href="#CommandType">CommandType</a> are specified, a ::RowSet can be created with this information. If the results provided by the row set are to be additionally filtered, the Filter property can be used.</p> <p>Note that the Filter property does not make sense if a <a href="#ResultSet">ResultSet</a> has been specified in the DataAccessDescriptor.</p> </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../sdb/module-ix.html">sdb</a>::<a href="../sdb/RowSet.html">RowSet</a>, <a href="#ResultSet">ResultSet</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="EscapeProcessing" class="membertitle">EscapeProcessing</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] boolean <b>EscapeProcessing</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies if the <a href="#Command">Command</a> should be analyzed on the client side before sending it to the database server. </dd> <dd><p>The default value of this property is <b>true</b>. By switching it to <b>false</b>, you can pass backend-specific SQL statements, which are not standard SQL, to your database.</p> <p>This property is usually present together with the <a href="#Command">Command</a> and <a href="#CommandType">CommandType</a> properties, and is evaluated if and only if <a href="#CommandType">CommandType</a> equals ::CommandType::COMMAND.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ActiveConnection" class="membertitle">ActiveConnection</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] ::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XConnection.html">XConnection</a> <b>ActiveConnection</b><dl> <dd>set raises (::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>specifies the active connection which is used to create the resulting report. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="DataSourceName" class="membertitle">DataSourceName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] string <b>DataSourceName</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>is the name of the datasource to use, this could be a named datasource or the URL of a data access component. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ReportHeaderOn" class="membertitle">ReportHeaderOn</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] boolean <b>ReportHeaderOn</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Defines that the report header is on. Default is <b>false</b>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ReportFooterOn" class="membertitle">ReportFooterOn</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] boolean <b>ReportFooterOn</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Defines that the report footer is on. Default is <b>false</b>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="PageHeaderOn" class="membertitle">PageHeaderOn</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] boolean <b>PageHeaderOn</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Defines that the page header is on. Default is <b>true</b>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="PageFooterOn" class="membertitle">PageFooterOn</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] boolean <b>PageFooterOn</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Defines that the page footer is on. Default is <b>true</b>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Groups" class="membertitle">Groups</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] <a href="XGroups.html">XGroups</a> <b>Groups</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Represents the groups of the report. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ReportHeader" class="membertitle">ReportHeader</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>ReportHeader</b><dl> <dd>get raises (::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the report header if the <a href="#ReportHeaderOn">ReportHeaderOn</a>is <b>true</b>. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> If the report has the report header disabled. </dd> <dt><b>See also</b></dt> <dd><a href="XSection.html">XSection</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="PageHeader" class="membertitle">PageHeader</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>PageHeader</b><dl> <dd>get raises (::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the page header if the <a href="#PageHeaderOn">PageHeaderOn</a>is <b>true</b>. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> If the report has the page header disabled. </dd> <dt><b>See also</b></dt> <dd><a href="XSection.html">XSection</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Detail" class="membertitle">Detail</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>Detail</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>returns the detail section. </dd> <dt><b>See also</b></dt> <dd><a href="XSection.html">XSection</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="PageFooter" class="membertitle">PageFooter</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>PageFooter</b><dl> <dd>get raises (::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the page footer if the <a href="#PageFooterOn">PageFooterOn</a>is <b>true</b>. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> If the report has the page footer disabled. </dd> <dt><b>See also</b></dt> <dd><a href="XSection.html">XSection</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ReportFooter" class="membertitle">ReportFooter</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>ReportFooter</b><dl> <dd>get raises (::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the report footer if the <a href="#ReportFooterOn">ReportFooterOn</a>is <b>true</b>. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::container::NullPointerException If the report has the report footer disabled. </dd> <dt><b>See also</b></dt> <dd><a href="XSection.html">XSection</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 © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
