Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: report ::
unpublished | interface XReportDefinition |
  Base Interfaces
      XReportDefinition
      ┣ ::com::sun::star::frame::XModel
      ┃ ┗ ::com::sun::star::lang::XComponent
      ┣ ::com::sun::star::frame::XLoadable
      ┣ ::com::sun::star::embed::XVisualObject
      ┣ ::com::sun::star::document::XStorageBasedDocument
      ┣ ::com::sun::star::document::XViewDataSupplier
      ┣ ::com::sun::star::util::XCloseable
      ┃ ┗ ::com::sun::star::util::XCloseBroadcaster
      ┣ ::com::sun::star::ui::XUIConfigurationManagerSupplier
      ┣ ::com::sun::star::document::XDocumentSubStorageSupplier
      ┣ ::com::sun::star::style::XStyleFamiliesSupplier
      ┣ ::com::sun::star::util::XModifiable2
      ┃ ┗ ::com::sun::star::util::XModifiable
      ┃    ┗ ::com::sun::star::util::XModifyBroadcaster
      ┣ XReportComponent
      ┃ ┣ ::com::sun::star::util::XCloneable
      ┃ ┣ ::com::sun::star::container::XChild
      ┃ ┣ ::com::sun::star::lang::XComponent
      ┃ ┣ ::com::sun::star::drawing::XShape
      ┃ ┃ ┗ ::com::sun::star::drawing::XShapeDescriptor
      ┃ ┗ ::com::sun::star::beans::XPropertySet
      ┗ XFunctionsSupplier
  ::com::sun::star::frame::XModel | Description allows the access to the model embedded in the database storage.
  ::com::sun::star::frame::XLoadable | Description offers a simple way to initialize a component.
  ::com::sun::star::embed::XVisualObject | Description represents common visualization functionality for the embedded report.
  ::com::sun::star::document::XStorageBasedDocument | Description allows to initialize the document with a storage.
  ::com::sun::star::document::XViewDataSupplier | Description gives access to some properties describing all open views to a document.
  ::com::sun::star::util::XCloseable | Description allows to close the document.
  ::com::sun::star::ui::XUIConfigurationManagerSupplier | Description allows to retrieve the user interface configuration manager related to an object.
  ::com::sun::star::document::XDocumentSubStorageSupplier | (referenced interface's summary:) through this interface documents can provide access to their substorages
  ::com::sun::star::style::XStyleFamiliesSupplier | Description provides access to the collection of style families. A spreadsheet document contains 2 families of styles: "PageStyles" and "CellStyles".
  ::com::sun::star::util::XModifiable2 | Description a storable document should provide information about his modify state 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.
  XReportComponent | Description allows the creation of sub reports.
  XFunctionsSupplier | Description gives access to functions defined in the report definition.
Usage Restrictions not published Description identifies a XReportComponent as being a (sub-) report. This interface does not really provide an own functionality, it is only for easier runtime identification of report components. A report fulfills several tasks, like storing the structure of its report components and it provides the event environment for its contained elements. See also XReportComponent

Methods' Summary
getEventBroadcaster | 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::document::XEventBroadcaster because the methods addEventListener and removeEventListener are already defined in ::com::sun::star::lang::XComponent. A queryInterface call is still supported to the ::com::sun::star::document::XEventBroadcaster interface.
getAvailableMimeTypes | returns a sequence of the currently supported output formats.

Attributes' Summary
MimeType | Represents the output format (media (mime) type) of the resulting document when executing this report.
Caption | Represents the title of the report in print preview.
GroupKeepTogether | Specifies whether groups in a multi column report are kept together.
PageHeaderOption | Represents the location of the page header.
PageFooterOption | Represents the location of the page footer.
Command | is the command which should be executed, the type of command depends on the CommandType.
CommandType | specifies the type of the command to be executed to retrieve a result set.
Filter | specifies an additional filter to optionally use.
EscapeProcessing | specifies if the Command should be analyzed on the client side before sending it to the database server.
ActiveConnection | specifies the active connection which is used to create the resulting report.
DataSourceName | is the name of the datasource to use, this could be a named datasource or the URL of a data access component.
ReportHeaderOn | Defines that the report header is on. Default is false.
ReportFooterOn | Defines that the report footer is on. Default is false.
PageHeaderOn | Defines that the page header is on. Default is true.
PageFooterOn | Defines that the page footer is on. Default is true.
Groups | Represents the groups of the report.
ReportHeader | returns the report header if the ReportHeaderOnis true.
PageHeader | returns the page header if the PageHeaderOnis true.
Detail | returns the detail section.
PageFooter | returns the page footer if the PageFooterOnis true.
ReportFooter | returns the report footer if the ReportFooterOnis true.

Methods' Details
getEventBroadcaster
::com::sun::star::document::XEventBroadcaster
getEventBroadcaster()
raises( | ::com::sun::star::lang::DisposedException, ::com::sun::star::uno::Exception );
Description 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::document::XEventBroadcaster because the methods addEventListener and removeEventListener are already defined in ::com::sun::star::lang::XComponent. A queryInterface call is still supported to the ::com::sun::star::document::XEventBroadcaster interface.
getAvailableMimeTypes
sequence< string >
getAvailableMimeTypes()
raises( | ::com::sun::star::lang::DisposedException, ::com::sun::star::uno::Exception );
Description returns a sequence of the currently supported output formats.

Attributes' Details
MimeType
[ bound ] string MimeType set raises (::com::sun::star::lang::IllegalArgumentException); Description Represents the output format (media (mime) type) of the resulting document when executing this report.
Caption
[ bound ] string Caption; Description Represents the title of the report in print preview.
GroupKeepTogether
[ bound ] short GroupKeepTogether set raises (::com::sun::star::lang::IllegalArgumentException); Description Specifies whether groups in a multi column report are kept together. See also com.sun.star.report.GroupKeepTogether
PageHeaderOption
[ bound ] short PageHeaderOption; Description Represents the location of the page header. See also ReportPrintOption
PageFooterOption
[ bound ] short PageFooterOption; Description Represents the location of the page footer. See also ReportPrintOption
Command
[ bound ] string Command; Description is the command which should be executed, the type of command depends on the CommandType. In case of a CommandType of ::CommandType::COMMAND, means in case the Command specifies an SQL statement, the inherited ::com::sun::star::sdbc::RowSet::EscapeProcessing becomes relevant: 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. The default value for ::com::sun::star::sdbc::RowSet::EscapeProcessing is true. By switching it to false, you can pass backend-specific SQL statements, which are not standard SQL, to your database. See also ::com::sun::star::sdb::CommandType
CommandType
[ bound ] long CommandType; Description specifies the type of the command to be executed to retrieve a result set. Command needs to be interpreted depending on the value of this property. This property is only meaningful together with the Command property, thus either both or none of them are present. See also ::com::sun::star::sdb::CommandType
Filter
[ bound ] string Filter; Description specifies an additional filter to optionally use. The Filter string has to form a SQL WHERE-clause, without the WHERE-string itself. If a DataSourceName, Command and CommandType 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. Note that the Filter property does not make sense if a ResultSet has been specified in the DataAccessDescriptor. See also ::com::sun::star::sdb::RowSet, ResultSet
EscapeProcessing
[ bound ] boolean EscapeProcessing; Description specifies if the Command should be analyzed on the client side before sending it to the database server. The default value of this property is true. By switching it to false, you can pass backend-specific SQL statements, which are not standard SQL, to your database. This property is usually present together with the Command and CommandType properties, and is evaluated if and only if CommandType equals ::CommandType::COMMAND.
ActiveConnection
[ bound ] ::com::sun::star::sdbc::XConnection ActiveConnection set raises (::com::sun::star::lang::IllegalArgumentException); Description specifies the active connection which is used to create the resulting report.
DataSourceName
[ bound ] string DataSourceName; Description is the name of the datasource to use, this could be a named datasource or the URL of a data access component.
ReportHeaderOn
[ bound ] boolean ReportHeaderOn; Description Defines that the report header is on. Default is false.
ReportFooterOn
[ bound ] boolean ReportFooterOn; Description Defines that the report footer is on. Default is false.
PageHeaderOn
[ bound ] boolean PageHeaderOn; Description Defines that the page header is on. Default is true.
PageFooterOn
[ bound ] boolean PageFooterOn; Description Defines that the page footer is on. Default is true.
Groups
[ readonly ] XGroups Groups; Description Represents the groups of the report.
ReportHeader
[ readonly ] XSection ReportHeader get raises (::com::sun::star::container::NoSuchElementException); Description returns the report header if the ReportHeaderOnis true. Throws ::com::sun::star::container::NoSuchElementException If the report has the report header disabled. See also XSection
PageHeader
[ readonly ] XSection PageHeader get raises (::com::sun::star::container::NoSuchElementException); Description returns the page header if the PageHeaderOnis true. Throws ::com::sun::star::container::NoSuchElementException If the report has the page header disabled. See also XSection
Detail
[ readonly ] XSection Detail; Description returns the detail section. See also XSection
PageFooter
[ readonly ] XSection PageFooter get raises (::com::sun::star::container::NoSuchElementException); Description returns the page footer if the PageFooterOnis true. Throws ::com::sun::star::container::NoSuchElementException If the report has the page footer disabled. See also XSection
ReportFooter
[ readonly ] XSection ReportFooter get raises (::com::sun::star::container::NoSuchElementException); Description returns the report footer if the ReportFooterOnis true. Throws com::sun::star::container::NullPointerException If the report has the report footer disabled. See also XSection

Top of Page

Copyright © 2000, 2014 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "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 trademark policy.