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 XSection
Base Interfaces
XSection
┣ ::com::sun::star::container::XChild
┣ ::com::sun::star::container::XContainer
┣ ::com::sun::star::drawing::XShapes
┃ ┗ ::com::sun::star::container::XIndexAccess
┃    ┗ ::com::sun::star::container::XElementAccess
┣ ::com::sun::star::container::XEnumerationAccess
┃ ┗ ::com::sun::star::container::XElementAccess
┣ ::com::sun::star::beans::XPropertySet
┗ ::com::sun::star::lang::XComponent

::com::sun::star::container::XChild
Description
allows to navigate to group or report definition.
::com::sun::star::container::XContainer
Description
allows to register listeners to be notified of changes in the container.
::com::sun::star::drawing::XShapes
Description
gives access to the elements by index.
::com::sun::star::container::XEnumerationAccess
Description
creates an enumeration of the elements.
::com::sun::star::beans::XPropertySet
Description
provides generic access to the instance properties
::com::sun::star::lang::XComponent
Description
allows life-time control of sections.
Description
identifies a XSection inside a report.

A section acts like a container of report components. This generic construction allows the definition of hierarchies of reports and their dependent subreports.

See also
XReportDefinition, XGroup

Attributes' Summary
Visible Defines if the section should be visible in report.  
Name Defines the name of the section.  
Height Defines the height of the section.  
BackColor Defines the back ground color of the section.  
BackTransparent determines if the back ground color is set to transparent.  
ConditionalPrintExpression Defines the expression which is executed before printing the section. If the return value of the expression is true then the section will be printed.  
ForceNewPage Specifies wether the section is printed on a separate page.  
NewRowOrCol Specifies wether the section is printed in a new row or column within a multi column report.  
KeepTogether Specifies that the section is printed on one page.  
CanGrow Specifies that elements with dynamic state will be expanded vertically when then content of the element is larger than it's container. If this property is disabled the content will be truncated when it's size is larger than the container.  
CanShrink  
RepeatSection Defines that the group header should be repeated on the next page when a group spans more than one page. It only applies to group headers.  
Group Specifies the parent of the section if it is a group header or group footer.  
ReportDefinition Specifies the parent of the section if it is a page header or page footer.  
Attributes' Details
Visible
[ bound ] boolean Visible;
Description
Defines if the section should be visible in report.
Name
[ bound ] string Name;
Description
Defines the name of the section.
Height
[ bound ] unsigned long Height;
Description
Defines the height of the section.
BackColor
[ bound ] ::com::sun::star::util::Color BackColor;
Description
Defines the back ground color of the section.
BackTransparent
[ bound ] boolean BackTransparent;
Description
determines if the back ground color is set to transparent.
ConditionalPrintExpression
[ bound ] string ConditionalPrintExpression;
Description
Defines the expression which is executed before printing the section. If the return value of the expression is true then the section will be printed.
ForceNewPage
[ bound ] short ForceNewPage
get raises (::com::sun::star::beans::UnknownPropertyException)
set raises (::com::sun::star::lang::IllegalArgumentException,::com::sun::star::beans::UnknownPropertyException);

Description
Specifies wether the section is printed on a separate page.

Not valid for page header or page footer.

See also
ForceNewPage
NewRowOrCol
[ bound ] short NewRowOrCol
get raises (::com::sun::star::beans::UnknownPropertyException)
set raises (::com::sun::star::lang::IllegalArgumentException,::com::sun::star::beans::UnknownPropertyException);

Description
Specifies wether the section is printed in a new row or column within a multi column report.

Not valid for page header or page footer.

See also
ForceNewPage
KeepTogether
[ bound ] boolean KeepTogether
get raises (::com::sun::star::beans::UnknownPropertyException)
set raises (::com::sun::star::lang::IllegalArgumentException,::com::sun::star::beans::UnknownPropertyException);

Description
Specifies that the section is printed on one page.

Not valid for page header or page footer.

CanGrow
[ bound ] boolean CanGrow
get raises (::com::sun::star::beans::UnknownPropertyException)
set raises (::com::sun::star::lang::IllegalArgumentException,::com::sun::star::beans::UnknownPropertyException);

Description
Specifies that elements with dynamic state will be expanded vertically when then content of the element is larger than it's container. If this property is disabled the content will be truncated when it's size is larger than the container.
CanShrink
[ bound ] boolean CanShrink
get raises (::com::sun::star::beans::UnknownPropertyException)
set raises (::com::sun::star::lang::IllegalArgumentException,::com::sun::star::beans::UnknownPropertyException);

Description

Represents ...

RepeatSection
[ bound ] boolean RepeatSection
get raises (::com::sun::star::beans::UnknownPropertyException)
set raises (::com::sun::star::lang::IllegalArgumentException,::com::sun::star::beans::UnknownPropertyException);

Description
Defines that the group header should be repeated on the next page when a group spans more than one page. It only applies to group headers.
Group
[ readonly ] XGroup Group;
Description
Specifies the parent of the section if it is a group header or group footer.
ReportDefinition
[ readonly ] XReportDefinition ReportDefinition;
Description
Specifies the parent of the section if it is a page header or page footer.
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.