The Free and Open Productivity Suite
QA Volunteers Needed -- Help us test OpenOffice

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous

Content for Apache OpenOffice version 3.4.
Overview Module Use Devguide Index
Services' Summary Interfaces' Summary Properties' Summary Services' Details Interfaces' Details Properties' Details

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

service DataPilotFieldGroup
Description
represents a collection of members in a data pilot field group.

The members (also called items) of this collection are instances of DataPilotFieldGroupItem.

See also
DataPilotField, DataPilotFieldGroups, DataPilotFieldGroupItem
Exported Interfaces - Summary
::com::sun::star::container::XNamed

provides access to the name of the data pilot field group. (details)
::com::sun::star::container::XIndexAccess

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

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

creates an enumeration of all data pilot field group members. (details)
::com::sun::star::container::XNameAccess

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

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

provides read/write access to the data pilot field group members in the collection via name. (details)
Exported Interfaces - Details
::com::sun::star::container::XNamed
Description
provides access to the name of the data pilot field group.

It is possible to change the name of this field group as long as the new name is not used in the collection of groups in the field.
::com::sun::star::container::XIndexAccess
Description
provides access to the data pilot field group members in the collection via index.
::com::sun::star::container::XEnumerationAccess
Description
creates an enumeration of all data pilot field group members.
See also
DataPilotFieldGroupEnumeration
::com::sun::star::container::XNameAccess
Description
provides access to the data pilot field group members in the collection via name.
::com::sun::star::container::XNameContainer
Usage Restrictions
optional
Description
provides read/write access to the data pilot field group members in the collection via name.

The ::com::sun::star::container::XNameContainer and ::com::sun::star::container::XNameReplace interfaces can be used to manage the members that this group contains. It is possible to insert, remove, and replace members.

The method ::com::sun::star::container::XNameReplace::replaceByName can be used to rename the specified member. To do so, the new name has to be passed as second argument. An implementation should support the following data types:

  • a non-empty string specifying the new name of the group member.
  • an object supporting the ::com::sun::star::container::XNamed interface, for example an instance of DataPilotFieldGroupItem received from another group.

The method ::com::sun::star::container::XNameContainer::insertByName can be used to insert a new member into this field group. An implementation should ignore the second argument and insert the specified member name.

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

 Top of Page

Copyright © 2012, 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 Feather

Copyright & License | Privacy | Contact Us | Donate

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.