:: 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
- 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
- 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 performed 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:
- If the member
DataPilotFieldGroupInfo::HasAutoStart is set to false, then the value of
DataPilotFieldGroupInfo::Start must be a floating-point
value representing a valid date/time value (if
DataPilotFieldGroupInfo::HasAutoStart is set to true,
the value of DataPilotFieldGroupInfo::Start will
be ignored).
- If the member
DataPilotFieldGroupInfo::HasAutoEnd is set to false, then the value of
DataPilotFieldGroupInfo::End must be a floating-point
value representing a valid date/time value( if
DataPilotFieldGroupInfo::HasAutoEnd is set to true,
the value of DataPilotFieldGroupInfo::End will be
ignored).
- If the members
DataPilotFieldGroupInfo::HasAutoStart and DataPilotFieldGroupInfo::HasAutoEnd
are set to false both, then the value of
DataPilotFieldGroupInfo::Start must be less than or equal
to the value of DataPilotFieldGroupInfo::End.
- The member DataPilotFieldGroupInfo::HasDateValues
must be set to true.
- The member DataPilotFieldGroupInfo::Step must
be zero, unless ranges of days have to be grouped (see the
description of the member GroupBy below), in that case the value
must be greater than or equal to 1 and less than or equal to 32767.
The fractional part of the value will be ignored.
- The member DataPilotFieldGroupInfo::GroupBy
must contain exactly one of the flags from DataPilotFieldGroupBy.
A combination of several flags will not be accepted. If
DataPilotFieldGroupBy::DAYS is specified, the
value of the member DataPilotFieldGroupInfo::Step
will specify the type of day grouping (see above). If that value
is zero, grouping is performed on all days of the year (e.g. the
members containing the 1st of January of any year are grouped
together). If that value is greater than zero, grouping is done on
ranges of days, and the value specifies the number of days grouped
into one range (e.g. a value of 7 groups the members of a week
into a range).
- The contents of the member
DataPilotFieldGroupInfo::SourceField will be ignored.
- The contents of the member
DataPilotFieldGroupInfo::Groups will be ignored.
- 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
Copyright © 2000, 2012 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.