Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: report ::

interface XReportComponent
Base Interfaces
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

::com::sun::star::util::XCloneable
(referenced interface's summary:)
makes it possible to create a copy of the object which supports this interface.
::com::sun::star::container::XChild
Description
identifies the component as a candidate for being part of a report.

This interface also provides the access to the component's parent.

::com::sun::star::lang::XComponent
Description
allows life-time control of report components.
::com::sun::star::drawing::XShape
(referenced interface's summary:)
lets you do a basic transformation on a ::com::sun::star::drawing::Shape and get its type.
::com::sun::star::beans::XPropertySet
Description
gives access to the properties.
Description
describes a component which may be part of a report.
See also
XReportDefinition

Attributes' Summary
Name the name of the component.  
Height specifies the height of the control.  
PositionX specifies the horizontal position of the control.  
PositionY specifies the vertical position of the control.  
Width specifies the width of the control.  
ControlBorder specifies the border style of the control.  
ControlBorderColor specifies the color of the border, if present  
PrintRepeatedValues Specifies that recurring values are printed. If set to true then the value will be printed every time. If set to false then the value will only be printed once. The default value is true.  
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.  
Section Specifies the section where the control belongs to. This is a shortcut to get control hierachy up. This value is NULL when the control was not inserted in any section.  
Attributes' Details
Name
[ bound ] string Name
set raises (::com::sun::star::beans::PropertyVetoException);

Description
the name of the component.
Height
[ bound ] long Height;
Description
specifies the height of the control.
PositionX
[ bound ] long PositionX;
Description
specifies the horizontal position of the control.
PositionY
[ bound ] long PositionY;
Description
specifies the vertical position of the control.
Width
[ bound ] long Width;
Description
specifies the width of the control.
ControlBorder
[ bound ] short ControlBorder
get raises (::com::sun::star::beans::UnknownPropertyException)
set raises (::com::sun::star::lang::IllegalArgumentException,::com::sun::star::beans::UnknownPropertyException);

Description
specifies the border style of the control.
 0: No border
 2: simple border
 
ControlBorderColor
[ bound ] long ControlBorderColor
get raises (::com::sun::star::beans::UnknownPropertyException)
set raises (::com::sun::star::lang::IllegalArgumentException,::com::sun::star::beans::UnknownPropertyException);

Description
specifies the color of the border, if present

Not every border style (see Border) may support coloring. For instance, usually a border with 3D effect will ignore the BorderColor setting.

PrintRepeatedValues
[ bound ] boolean PrintRepeatedValues
get raises (::com::sun::star::beans::UnknownPropertyException)
set raises (::com::sun::star::beans::UnknownPropertyException);

Description
Specifies that recurring values are printed. If set to true then the value will be printed every time. If set to false then the value will only be printed once. The default value is true.
MasterFields
[ bound ] sequence< string > MasterFields
get raises (::com::sun::star::beans::UnknownPropertyException)
set raises (::com::sun::star::beans::UnknownPropertyException);

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
get raises (::com::sun::star::beans::UnknownPropertyException)
set raises (::com::sun::star::beans::UnknownPropertyException);

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.

*
Section
[ readonly ] XSection Section;
Description
Specifies the section where the control belongs to. This is a shortcut to get control hierachy up. This value is NULL when the control was not inserted in any section.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.