interface XConsolidationDescriptor in module com::sun::star::sheet::

(Global Index)

Syntax

interface XConsolidationDescriptor : com::sun::star::uno::XInterface ;

Description

represents a description of how to consolidate multiple cell ranges. @deprecated@see com::sun::star::sheet::ConsolidationDescriptor

Method Summary

getFunction returns the function by which the ranges are consolidated.

setFunction sets the function by which the ranges are consolidated.

getSources returns the cell ranges which are consolidated.

setSources sets the cell ranges which are consolidated.

getStartOutputPosition returns the position in the document where the consolidated data are copied.

setStartOutputPosition sets the position in the document where the consolidated data are copied.

getUseColumnHeaders returns whether column headers from the cell ranges are used to find matching data or not.

setUseColumnHeaders specifies if column headers from the cell ranges are used to find matching data.

getUseRowHeaders returns whether row headers from the cell ranges are used to find matching data or not.

setUseRowHeaders specifies if row headers from the cell ranges are used to find matching data.

getInsertLinks returns whether links to the original data are inserted in the output area or not.

setInsertLinks specifies if links to the original data are inserted in the output area.

Known Services Which Export this Interface

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

Method Details



getFunction

Syntax

com::sun::star::sheet::GeneralFunction getFunction ();

Description

returns the function by which the ranges are consolidated.


setFunction

Syntax

void setFunction (
com::sun::star::sheet::GeneralFunction nFunction );

Description

sets the function by which the ranges are consolidated.


getSources

Syntax

sequence< com::sun::star::table::CellRangeAddress > getSources ();

Description

returns the cell ranges which are consolidated.


setSources

Syntax

void setSources (
sequence< com::sun::star::table::CellRangeAddress > aSources );

Description

sets the cell ranges which are consolidated.


getStartOutputPosition

Syntax

com::sun::star::table::CellAddress getStartOutputPosition ();

Description

returns the position in the document where the consolidated data are copied.


setStartOutputPosition

Syntax

void setStartOutputPosition (
com::sun::star::table::CellAddress aStartOutputPosition );

Description

sets the position in the document where the consolidated data are copied.


getUseColumnHeaders

Syntax

boolean getUseColumnHeaders ();

Description

returns whether column headers from the cell ranges are used to find matching data or not.


setUseColumnHeaders

Syntax

void setUseColumnHeaders (
boolean bUseColumnHeaders );

Description

specifies if column headers from the cell ranges are used to find matching data.


getUseRowHeaders

Syntax

boolean getUseRowHeaders ();

Description

returns whether row headers from the cell ranges are used to find matching data or not.


setUseRowHeaders

Syntax

void setUseRowHeaders (
boolean bUseRowHeaders );

Description

specifies if row headers from the cell ranges are used to find matching data.


getInsertLinks

Syntax

boolean getInsertLinks ();

Description

returns whether links to the original data are inserted in the output area or not.


setInsertLinks

Syntax

void setInsertLinks (
boolean bInsertLinks );

Description

specifies if links to the original data are inserted in the output area.

Top of Page