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.
|
MasterFields |
is used for subreports and contains the names of columns of the parent report.
|
DetailFields |
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.
|
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 addtional filter to optinally use.
|
EscapeProcessing |
specifies if the Command should be analyzed on the client side before sending it
to the database server.
|
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 ReportHeaderOn is true .
|
PageHeader |
returns the page header if the PageHeaderOn is true .
|
Detail |
returns the detail section.
|
PageFooter |
returns the page footer if the PageFooterOn is true .
|
ReportFooter |
returns the report footer if the ReportFooterOn is true .
|
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
|
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
|
|
MasterFields
[ bound ] sequence< string > MasterFields;
- Description
- is used for subreports and contains the names of columns of the parent report.
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.
If the report is no sub report (e.g. it's parent is not a report itself), this
property is not evaluated.
|
|
DetailFields
[ bound ] sequence< string > DetailFields;
- Description
- 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.
Entries in this sequence can either denote column names in the sub report,
or paramater names.
For instance, you could base the report on the SQL statement
SELECT * FROM invoices WHERE cust_ref = :cid , and add cid
to the DetailFields property. In this case, the parameter will be filled from
the corresponding master field.
Alternatively, you could simply base your report on the table invoices ,
and add the column name cust_ref to the DetailFields. In this case,
and implicit filter clause WHERE cust_ref = :<new_param_name> will
be created, and the artificial parameter will be filled from the corresponding
master field.
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.
The columns specified herein typically represent a part of the primary key
fields or their aliases of the detail report.
If the report is no sub report (e.g. it's parent is not a report itself), this
property is not evaluated.
*
|
|
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 meaningfull 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 addtional filter to optinally 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 .
|
|
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
|
PageHeader
|
Detail
[ readonly ] XSection Detail;
- Description
- returns the detail section.
- See also
- XSection
|
|
PageFooter
|
ReportFooter
|
Copyright © 2003 Sun Microsystems, Inc.