LibreOffice
LibreOffice 7.4 SDK API Reference
Public Member Functions | List of all members
XConsolidatable Interface Referencepublished

provides methods to consolidate ranges in a spreadsheet document. More...

import"XConsolidatable.idl";

Inheritance diagram for XConsolidatable:
XInterface SpreadsheetDocument

Public Member Functions

com::sun::star::sheet::XConsolidationDescriptor createConsolidationDescriptor ([in] boolean bEmpty)
 creates a consolidation descriptor. More...
 
void consolidate ([in] com::sun::star::sheet::XConsolidationDescriptor xDescriptor)
 consolidates data from several cell ranges, using the settings in the passed descriptor. 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...
 

Detailed Description

provides methods to consolidate ranges in a spreadsheet document.

Consolidation combines the cells of multiple cell ranges, using a specific function.

Deprecated:
Developers Guide
Spreadsheet Documents - Other Table Operations - Data Consolidation

Member Function Documentation

◆ consolidate()

void consolidate ( [in] com::sun::star::sheet::XConsolidationDescriptor  xDescriptor)

consolidates data from several cell ranges, using the settings in the passed descriptor.

Parameters
xDescriptorthe descriptor used to perform the consolidation.
See also
com::sun::star::sheet::ConsolidationDescriptor

◆ createConsolidationDescriptor()

com::sun::star::sheet::XConsolidationDescriptor createConsolidationDescriptor ( [in] boolean  bEmpty)

creates a consolidation descriptor.

Parameters
bEmptyTRUE leaves the descriptor empty, FALSE fills it with the settings from the last consolidation action.
See also
com::sun::star::sheet::ConsolidationDescriptor

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