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 :: sheet ::

interface XDataPilotFieldGrouping
Description
Provides methods to create new DataPilot fields where some or all items of this DataPilot field are grouped in some way.
See also
DataPilotField

Methods' Summary
createNameGroup Creates a new DataPilot field which contains a group containing the given DataPilot field items (members).  
createDateGroup Groups the members of this field by dates, according to the passed settings.  
Methods' Details
createNameGroup
XDataPilotField
createNameGroup( [in] sequence< string >  aItems )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
Creates a new DataPilot field which contains a group containing the given DataPilot field items (members).

It is possible to create multiple groups by calling this method several times at the same DataPilot field. On subsequent calls, the DataPilot field created at the first call is used to insert the new groups.

The collection of groups can be accessed via the DataPilotField::GroupInfo property. The returned struct contains the sequence of groups in its member DataPilotFieldGroupInfo::Groups.

Parameter aItems
a sequence containing the names of the items (members) which will be part of the new group. Must be names of items contained in the current field.
Returns
the new created field if there is one created on the first call of this method. NULL is returned on subsequent calls.
See also
DataPilotField, DataPilotFieldGroupInfo
createDateGroup
XDataPilotField
createDateGroup( [in] DataPilotFieldGroupInfo  aInfo )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
Groups the members of this field by dates, according to the passed settings.

If this field is already grouped by dates, a new DataPilot field will be created and returned. If this field is not grouped at all, the date grouping is perfomed inside of this field (no new field will be created). There must not be any other grouping (by member names or by numeric ranges), otherwise an exception is thrown.

Parameter aInfo
contains the information how to group the items of the field. The members of this struct have to fulfill the following requirements:
Returns
the new created field if there is one created. NULL is returned, if date grouping is performed inside this field (i.e. this field was not grouped by dates before).
Throws
com::sun::star::lang::IllegalArgumentException if the passed struct does not contain valid settings as described, or if this field is already grouped by member names or numeric ranges.
See also
DataPilotField
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.