Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

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

interface XReportControlModel
Base Interfaces
XReportControlModel
┣ 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
┣ XReportControlFormat
┣ ::com::sun::star::container::XContainer
┗ ::com::sun::star::container::XIndexContainer
   ┗ ::com::sun::star::container::XIndexReplace
      ┗ ::com::sun::star::container::XIndexAccess
         ┗ ::com::sun::star::container::XElementAccess
XReportComponent
Description
allows the creation of sub reports.
XReportControlFormat
(referenced interface's summary:)
specifies a format condition for a control.
::com::sun::star::container::XContainer
Description
allows to register listeners to be notified of changes in the container.
::com::sun::star::container::XIndexContainer
Description
gives access to the XFormatCondition elements by index.
Methods' Summary
createFormatCondition Creates a format condition.  
Attributes' Summary
DataField Specifies which content should be shown. The value can be
  • the name of a database column. The format to use is field:[name]
  • the name of a function defined in the report or a group. The format to use is rpt:[functionName]
  • an expression like rpt:24+24-47
    •  
    PrintWhenGroupChange Specifies that the element gets printed when the group changes. The default value is false.  
    ConditionalPrintExpression Describes the print expression of the report control model. If the expression evaluates to true than the report control model will be printed otherwise not.  
    Methods' Details
    createFormatCondition
    XFormatCondition
    createFormatCondition()
    raises( ::com::sun::star::uno::Exception );
    Description
    Creates a format condition.
    Returns
    report component
    Attributes' Details
    DataField
    [ bound ] string DataField
    get raises (::com::sun::star::beans::UnknownPropertyException)
    set raises (::com::sun::star::lang::IllegalArgumentException,::com::sun::star::beans::UnknownPropertyException);
    Description
    Specifies which content should be shown. The value can be
  • the name of a database column. The format to use is field:[name]
  • the name of a function defined in the report or a group. The format to use is rpt:[functionName]
  • an expression like rpt:24+24-47
    • See also
    http://wiki.services.openoffice.org/wiki/SUN_Report_Builder, http://wiki.services.openoffice.org/wiki/SUN_Report_Builder#Syntax, http://wiki.services.openoffice.org/wiki/Base/Reports/Functions
    PrintWhenGroupChange
    [ bound ] boolean PrintWhenGroupChange
    get raises (::com::sun::star::beans::UnknownPropertyException)
    set raises (::com::sun::star::beans::UnknownPropertyException);
    Description
    Specifies that the element gets printed when the group changes. The default value is false.
    ConditionalPrintExpression
    [ bound ] string ConditionalPrintExpression
    get raises (::com::sun::star::beans::UnknownPropertyException)
    set raises (::com::sun::star::beans::UnknownPropertyException);
    Description
    Describes the print expression of the report control model. If the expression evaluates to true than the report control model will be printed otherwise not.
    Top of Page

    Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

    Apache Software Foundation

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

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