Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

interface XDataPilotDescriptor
Base Interfaces
XDataPilotDescriptor
┗ ::com::sun::star::container::XNamed

::com::sun::star::container::XNamed
(referenced interface's summary:)
specifies the name of the object.
Description
provides access to the layout settings of a data pilot table.

This interface extends the interface ::com::sun::star::container::XNamed which provides access to the name of the data pilot table used e.g. in collections.

See also
DataPilotDescriptor, DataPilotTable

Methods' Summary
getTag returns an additional string stored in the data pilot table.  
setTag sets an additional string stored in the data pilot table.  
getSourceRange returns the cell range containing the data for the data pilot table.  
setSourceRange sets the cell range containing the data for the data pilot table.  
getFilterDescriptor returns the filter descriptor specifying which data from the source cell range are used for the data pilot table.  
getDataPilotFields returns the collection of all the data pilot fields.  
getColumnFields returns the collection of the data pilot fields used as column fields.  
getRowFields returns the collection of the data pilot fields used as row fields.  
getPageFields returns the collection of the data pilot fields used as page fields.  
getDataFields returns the collection of the data pilot fields used as data fields.  
getHiddenFields returns the collection of the data pilot fields not used as column, row, page, or data fields.  
Methods' Details
getTag
string
getTag();

Description
returns an additional string stored in the data pilot table.
setTag
void
setTag( [in] string  aTag );

Description
sets an additional string stored in the data pilot table.
getSourceRange
::com::sun::star::table::CellRangeAddress
getSourceRange();

Description
returns the cell range containing the data for the data pilot table.
setSourceRange
void
setSourceRange( [in] ::com::sun::star::table::CellRangeAddress  aSourceRange );

Description
sets the cell range containing the data for the data pilot table.
getFilterDescriptor
XSheetFilterDescriptor
getFilterDescriptor();

Description
returns the filter descriptor specifying which data from the source cell range are used for the data pilot table.
getDataPilotFields
::com::sun::star::container::XIndexAccess
getDataPilotFields();

Description
returns the collection of all the data pilot fields.
getColumnFields
::com::sun::star::container::XIndexAccess
getColumnFields();

Description
returns the collection of the data pilot fields used as column fields.
See also
DataPilotFields
getRowFields
::com::sun::star::container::XIndexAccess
getRowFields();

Description
returns the collection of the data pilot fields used as row fields.
See also
DataPilotFields
getPageFields
::com::sun::star::container::XIndexAccess
getPageFields();

Description
returns the collection of the data pilot fields used as page fields.
See also
DataPilotFields
getDataFields
::com::sun::star::container::XIndexAccess
getDataFields();

Description
returns the collection of the data pilot fields used as data fields.
See also
DataPilotFields
getHiddenFields
::com::sun::star::container::XIndexAccess
getHiddenFields();

Description
returns the collection of the data pilot fields not used as column, row, page, or data fields.
See also
DataPilotFields
Top of Page

Apache Software Foundation

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

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.