represents the description of the layout of a data pilot table. More...

import"DataPilotDescriptor.idl";

Inheritance diagram for DataPilotDescriptor:

Public Types
typedef sequence< com::sun::star::beans::PropertyValue >	ImportDescriptor
	specifies parameters to create the data pilot table from a database. More...

typedef sequence< com::sun::star::beans::PropertyValue >	ServiceArguments
	specifies arguments that are passed to the implementation named by SourceServiceName. More...

Exported Interfaces
interface	XDataPilotDescriptor
	provides access to the layout settings of the data pilot table. More...

interface	com::sun::star::beans::XPropertySet
	provides access to the layout settings of the data pilot table. More...

interface	XDataPilotDataLayoutFieldSupplier
	Provides access to the DataPilotField used to layout multiple data fields. More...

Public Attributes
string	SourceServiceName
	specifies the name of a DataPilotSource implementation for the data pilot table. More...

boolean	IgnoreEmptyRows
	specifies if empty rows in the source data are ignored. More...

boolean	RepeatIfEmpty
	specifies if empty category cells in the source data should be treated as repetition of the content from the previous row. More...

boolean	ColumnGrand
	specifies if columns for grand total results are created. More...

boolean	RowGrand
	specifies if rows for grand total results are created. More...

boolean	ShowFilterButton
	specifies whether the filter button is shown. More...

boolean	DrillDownOnDoubleClick
	specifies whether to drill down to details or go into edit mode. More...

string	GrandTotalName
	specifies a label for grand total results. More...

Additional Inherited Members
Public Member Functions inherited from XDataPilotDescriptor
string	getTag ()
	returns an additional string stored in the data pilot table. More...

void	setTag ([in] string aTag)
	sets an additional string stored in the data pilot table. More...

com::sun::star::table::CellRangeAddress	getSourceRange ()
	returns the cell range containing the data for the data pilot table. More...

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

com::sun::star::sheet::XSheetFilterDescriptor	getFilterDescriptor ()
	returns the filter descriptor specifying which data from the source cell range are used for the data pilot table. More...

com::sun::star::container::XIndexAccess	getDataPilotFields ()
	returns the collection of all the data pilot fields. More...

com::sun::star::container::XIndexAccess	getColumnFields ()
	returns the collection of the data pilot fields used as column fields. More...

com::sun::star::container::XIndexAccess	getRowFields ()
	returns the collection of the data pilot fields used as row fields. More...

com::sun::star::container::XIndexAccess	getPageFields ()
	returns the collection of the data pilot fields used as page fields. More...

com::sun::star::container::XIndexAccess	getDataFields ()
	returns the collection of the data pilot fields used as data fields. More...

com::sun::star::container::XIndexAccess	getHiddenFields ()
	returns the collection of the data pilot fields not used as column, row, page, or data fields. More...

Public Member Functions inherited from XNamed
string	getName ()

void	setName ([in] string aName)
	sets the programmatic name of the object. More...

Public Member Functions inherited from XInterface
any	queryInterface ([in] type aType)
	queries for a new interface to an existing UNO object. More...

void	acquire ()
	increases the reference counter by one. More...

void	release ()
	decreases the reference counter by one. More...

Protected Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo	getPropertySetInfo ()

void	setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
	sets the value of the property with the specified name. More...

any	getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )

void	addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	adds an XPropertyChangeListener to the specified property. More...

void	removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	removes an XPropertyChangeListener from the listener list. More...

void	addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	adds an XVetoableChangeListener to the specified property with the name PropertyName. More...

void	removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
	removes an XVetoableChangeListener from the listener list. More...

Protected Member Functions inherited from XDataPilotDataLayoutFieldSupplier
XDataPilotField	getDataLayoutField ()
	Returns the DataPilotField used to layout multiple data fields. More...

Detailed Description

represents the description of the layout of a data pilot table.

See also: com::sun::star::sheet::DataPilotTable

Developers Guide: Spreadsheet Documents - Creating a New DataPilot Table

Member Typedef Documentation

◆ ImportDescriptor

sequence< com::sun::star::beans::PropertyValue > ImportDescriptor

optionalproperty

specifies parameters to create the data pilot table from a database.

See also: DatabaseImportDescriptor

Since: OOo 3.3

◆ ServiceArguments

sequence< com::sun::star::beans::PropertyValue > ServiceArguments

optionalproperty

specifies arguments that are passed to the implementation named by SourceServiceName.

Since: OOo 3.3

Exported Interfaces

◆ com::sun::star::beans::XPropertySet

interface com::sun::star::beans::XPropertySet

optional

provides access to the layout settings of the data pilot table.

◆ XDataPilotDataLayoutFieldSupplier

interface XDataPilotDataLayoutFieldSupplier

optional

Provides access to the DataPilotField used to layout multiple data fields.

◆ XDataPilotDescriptor

interface XDataPilotDescriptor

provides access to the layout settings of the data pilot table.

Member Data Documentation

◆ ColumnGrand

boolean ColumnGrand

optionalproperty

specifies if columns for grand total results are created.

◆ DrillDownOnDoubleClick

boolean DrillDownOnDoubleClick

optionalproperty

specifies whether to drill down to details or go into edit mode.

◆ GrandTotalName

string GrandTotalName

optionalproperty

specifies a label for grand total results.

Since: OOo 3.4

◆ IgnoreEmptyRows

boolean IgnoreEmptyRows

optionalproperty

specifies if empty rows in the source data are ignored.

◆ RepeatIfEmpty

boolean RepeatIfEmpty

optionalproperty

specifies if empty category cells in the source data should be treated as repetition of the content from the previous row.

◆ RowGrand

boolean RowGrand

optionalproperty

specifies if rows for grand total results are created.

◆ ShowFilterButton

boolean ShowFilterButton

optionalproperty

specifies whether the filter button is shown.

◆ SourceServiceName

string SourceServiceName

optionalproperty

specifies the name of a DataPilotSource implementation for the data pilot table.

Since: OOo 3.3

The documentation for this service was generated from the following file:

com/sun/star/sheet/DataPilotDescriptor.idl

Public Types

Exported Interfaces

Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ImportDescriptor

◆ ServiceArguments

Exported Interfaces

◆ com::sun::star::beans::XPropertySet

◆ XDataPilotDataLayoutFieldSupplier

◆ XDataPilotDescriptor

Member Data Documentation

◆ ColumnGrand

◆ DrillDownOnDoubleClick

◆ GrandTotalName

◆ IgnoreEmptyRows

◆ RepeatIfEmpty

◆ RowGrand

◆ ShowFilterButton

◆ SourceServiceName