LibreOffice
LibreOffice 24.2 SDK API Reference
Exported Interfaces | Public Attributes | List of all members
XReportComponent Interface Reference

describes a component which may be part of a report. More...

import"XReportComponent.idl";

Inheritance diagram for XReportComponent:
XCloneable XChild XComponent XShape XPropertySet XInterface XInterface XInterface XShapeDescriptor XInterface XInterface XReportControlModel XReportDefinition ReportControlModel XFixedLine XFixedText XFormattedField XImageControl XShape ReportDefinition FixedLine FixedText FormattedField ImageControl Shape

Exported Interfaces

interface com::sun::star::util::XCloneable
 
interface com::sun::star::container::XChild
 identifies the component as a candidate for being part of a report. More...
 
interface com::sun::star::lang::XComponent
 allows life-time control of report components. More...
 
interface com::sun::star::drawing::XShape
 
interface com::sun::star::beans::XPropertySet
 gives access to the properties. More...
 

Public Attributes

string Name { set raises(com::sun::star::beans::PropertyVetoException); }
 the name of the component. More...
 
long Height { set raises(com::sun::star::beans::PropertyVetoException); }
 specifies the height of the control. More...
 
long PositionX
 specifies the horizontal position of the control. More...
 
long PositionY
 specifies the vertical position of the control. More...
 
long Width { set raises(com::sun::star::beans::PropertyVetoException); }
 specifies the width of the control. More...
 
boolean AutoGrow { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 Specifies that the control containing data shall automatically grow to the optimal height to show the data without wasting space. More...
 
short ControlBorder { set raises(com::sun::star::lang::IllegalArgumentException, com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 specifies the border style of the control. More...
 
long ControlBorderColor { set raises(com::sun::star::lang::IllegalArgumentException, com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 specifies the color of the border, if present More...
 
boolean PrintRepeatedValues { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 Specifies that recurring values are printed. More...
 
sequence< string > MasterFields { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 is used for subreports and contains the names of columns of the parent report. More...
 
sequence< string > DetailFields { set raises(com::sun::star::beans::UnknownPropertyException); get raises(com::sun::star::beans::UnknownPropertyException); }
 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. More...
 
com::sun::star::report::XSection Section
 Specifies the section where the control belongs to. More...
 

Additional Inherited Members

- Public Member Functions inherited from XCloneable
com::sun::star::util::XCloneable createClone ()
 creates a copy of the object. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 
- Public Member Functions inherited from XChild
com::sun::star::uno::XInterface getParent ()
 grants access to the object containing this content. More...
 
void setParent ([in] com::sun::star::uno::XInterface Parent) raises ( com::sun::star::lang::NoSupportException )
 sets the parent to this object. More...
 
- Public Member Functions inherited from XComponent
void dispose ()
 The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More...
 
void addEventListener ([in] XEventListener xListener)
 adds an event listener to the object. More...
 
void removeEventListener ([in] XEventListener aListener)
 removes an event listener from the listener list. More...
 
- Public Member Functions inherited from XShape
com::sun::star::awt::Point getPosition ()
 gets the current position of this object. More...
 
void setPosition ([in] com::sun::star::awt::Point aPosition)
 sets the current position of this object More...
 
com::sun::star::awt::Size getSize ()
 gets the size of this object. More...
 
void setSize ([in] com::sun::star::awt::Size aSize) raises ( com::sun::star::beans::PropertyVetoException )
 sets the size of this object. More...
 
- Public Member Functions inherited from XShapeDescriptor
string getShapeType ()
 
- Public Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo getPropertySetInfo ()
 
void setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the value of the property with the specified name. More...
 
any getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 
void addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XPropertyChangeListener to the specified property. More...
 
void removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XPropertyChangeListener from the listener list. More...
 
void addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XVetoableChangeListener to the specified property with the name PropertyName. More...
 
void removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XVetoableChangeListener from the listener list. More...
 

Detailed Description

describes a component which may be part of a report.

See also
XReportDefinition

Exported Interfaces

◆ com::sun::star::beans::XPropertySet

gives access to the properties.

◆ com::sun::star::container::XChild

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::drawing::XShape

◆ com::sun::star::lang::XComponent

allows life-time control of report components.

◆ com::sun::star::util::XCloneable

Member Data Documentation

◆ AutoGrow

Specifies that the control containing data shall automatically grow to the optimal height to show the data without wasting space.

◆ ControlBorder

specifies the border style of the control.

0: No border
2: simple border

◆ ControlBorderColor

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.

◆ DetailFields

sequence<string> DetailFields
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

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 parameter 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 parameter 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. its parent is not a report itself), this property is not evaluated.

◆ Height

long Height
set raises(com::sun::star::beans::PropertyVetoException
)
attributebound

specifies the height of the control.

◆ MasterFields

sequence<string> MasterFields
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

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 these columns are used to identify the data for the subreport. Each time the parent report changes its 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. its parent is not a report itself), this property is not evaluated.

◆ Name

string Name
set raises(com::sun::star::beans::PropertyVetoException
)
attributebound

the name of the component.

◆ PositionX

long PositionX
attributebound

specifies the horizontal position of the control.

◆ PositionY

long PositionY
attributebound

specifies the vertical position of the control.

◆ PrintRepeatedValues

boolean PrintRepeatedValues
set raises(com::sun::star::beans::UnknownPropertyException
)
get raises(com::sun::star::beans::UnknownPropertyException
)
attributebound

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.

◆ Section

Specifies the section where the control belongs to.

This is a shortcut to get control hierarchy up. This value is NULL when the control was not inserted in any section.

◆ Width

long Width
set raises(com::sun::star::beans::PropertyVetoException
)
attributebound

specifies the width of the control.


The documentation for this interface was generated from the following file: