Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: report ::
unpublished | interface XGroup |
  Base Interfaces
      XGroup
      ┣ ::com::sun::star::container::XChild
      ┣ ::com::sun::star::beans::XPropertySet
      ┣ ::com::sun::star::lang::XComponent
      ┗ XFunctionsSupplier
  ::com::sun::star::container::XChild | Description allows access to the groups collection of the report.
  ::com::sun::star::beans::XPropertySet | Description allows access to the properties of the instance.
  ::com::sun::star::lang::XComponent | Description allows life-time control of group instances.
  XFunctionsSupplier | Description gives access to functions defined in the group definition.
Usage Restrictions not published Description identifies a XGroup. A group is always a child of the groups collection in the report. See also XReportDefinition, XGroups

Attributes' Summary
SortAscending | Defines if the group is sorted ascending or descending. The default is true.
HeaderOn | Defines if a group has a header.
FooterOn | Defines if a group has a footer.
Header | returns the group header.
Footer | returns the group footer.
GroupOn | Specifies how to group data.
GroupInterval | Defines an interval value that rows are grouped by.
KeepTogether | Specifies if a group header, detail, and footer section is printed on the same page.
Groups | Specifies the parent of the group.
Expression | Defines either a column name or an expression.
StartNewColumn | Specifies that the group header should always be printed on a new column.
ResetPageNumber | Specifies that the group header should always be printed on a new page and the reset of the page number to zero.

Attributes' Details
SortAscending
[ bound ] boolean SortAscending; Description Defines if the group is sorted ascending or descending. The default is true.
HeaderOn
[ bound ] boolean HeaderOn; Description Defines if a group has a header.
FooterOn
[ bound ] boolean FooterOn; Description Defines if a group has a footer.
Header
[ readonly ] XSection Header get raises (::com::sun::star::container::NoSuchElementException); Description returns the group header. Throws ::com::sun::star::container::NoSuchElementException If the group has the header disabled. See also XSection
Footer
[ readonly bound ] XSection Footer get raises (::com::sun::star::container::NoSuchElementException); Description returns the group footer. Throws ::com::sun::star::container::NoSuchElementException If the group has the footer disabled. See also XSection
GroupOn
[ bound ] short GroupOn set raises (::com::sun::star::lang::IllegalArgumentException); Description Specifies how to group data. See also GroupOn
GroupInterval
[ bound ] long GroupInterval; Description Defines an interval value that rows are grouped by.
KeepTogether
[ bound ] short KeepTogether set raises (::com::sun::star::lang::IllegalArgumentException); Description Specifies if a group header, detail, and footer section is printed on the same page. See also KeepTogether
Groups
[ readonly ] XGroups Groups; Description Specifies the parent of the group. See also XChild
Expression
[ bound ] string Expression; Description Defines either a column name or an expression.
StartNewColumn
[ bound ] boolean StartNewColumn; Description Specifies that the group header should always be printed on a new column.
ResetPageNumber
[ bound ] boolean ResetPageNumber; Description Specifies that the group header should always be printed on a new page and the reset of the page number to zero.

Top of Page

Copyright © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.