English:

The Free and Open Productivity Suite
New: Apache OpenOffice 4.1.1 released!

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: sheet ::

service DataPilotFieldGroups
Description
represents a collection of groups in a data pilot field.

The members of this collection are instances of DataPilotFieldGroup containing the names of all items in the group.

See also
DataPilotField, DataPilotFieldGroup, DataPilotFieldGroupInfo

Exported Interfaces - Summary
::com::sun::star::container::XIndexAccess

provides access to the data pilot field groups in the collection via index.

::com::sun::star::container::XEnumerationAccess

creates an enumeration of all data pilot field groups. (details)

::com::sun::star::container::XNameAccess

provides access to the data pilot field groups in the collection via name.

::com::sun::star::container::XNameContainer

provides read/write access to the data pilot field groups in the collection via name. (details)

Exported Interfaces - Details
::com::sun::star::container::XIndexAccess
Description
provides access to the data pilot field groups in the collection via index.
::com::sun::star::container::XEnumerationAccess
Description
creates an enumeration of all data pilot field groups.
See also
DataPilotFieldGroupsEnumeration
::com::sun::star::container::XNameAccess
Description
provides access to the data pilot field groups in the collection via name.
::com::sun::star::container::XNameContainer
Usage Restrictions
optional
Description
provides read/write access to the data pilot field groups in the collection via name.

The ::com::sun::star::container::XNameContainer and ::com::sun::star::container::XNameReplace interfaces can be used to manage the item groups. It is possible to insert, remove, and replace item groups.

The method ::com::sun::star::container::XNameReplace::replaceByName can be used to replace the item names in an existing group with a new collection of item names. An implementation should support the following data types:

  • an empty any to remove all items and leave the group empty. The group can be filled later with new item names.
  • a string[] containing all item names that will be part of the group.
  • an object supporting ::com::sun::star::container::XIndexAccess containing elements that provide an item name per element via the interface ::com::sun::star::container::XNamed, for example an instance of DataPilotFieldGroup.

The method ::com::sun::star::container::XNameContainer::insertByName can be used to insert a new field group with the passed collection of item names. An implementation should support the same data types as described above for the method ::com::sun::star::container::XNameReplace::replaceByName.

The method ::com::sun::star::container::XNameContainer::removeByName can be used to remove an existing field group.


 
Top of Page

Logo ApacheCon Europe 2014

Apache Feather

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

Apache, the Apache feather logo, and OpenOffice are trademarks of The Apache Software Foundation. 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.