Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

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

interface XConsolidationDescriptor

Base Interface
com::sun::star::uno::XInterface

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


Known Services which Export this Interface

com::sun::star::sheet::ConsolidationDescriptor a description of how data are consolidated.

Methods' 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.

Methods' Details

getFunction
 
com::sun::star::sheet::GeneralFunction
getFunction();
Description
returns the function by which the ranges are consolidated.
setFunction
 
void
setFunction(
[ in ] com::sun::star::sheet::GeneralFunction nFunction );

Description
sets the function by which the ranges are consolidated.
getSources
 
sequence< com::sun::star::table::CellRangeAddress >
getSources();
Description
returns the cell ranges which are consolidated.
setSources
 
void
setSources(
[ in ] sequence< com::sun::star::table::CellRangeAddress > aSources );

Description
sets the cell ranges which are consolidated.
getStartOutputPosition
 
com::sun::star::table::CellAddress
getStartOutputPosition();
Description
returns the position in the document where the consolidated data are copied.
setStartOutputPosition
 
void
setStartOutputPosition(
[ in ] com::sun::star::table::CellAddress aStartOutputPosition );

Description
sets the position in the document where the consolidated data are copied.
getUseColumnHeaders
 
boolean
getUseColumnHeaders();
Description
returns whether column headers from the cell ranges are used to find matching data or not.
setUseColumnHeaders
 
void
setUseColumnHeaders(
[ in ] boolean bUseColumnHeaders );

Description
specifies if column headers from the cell ranges are used to find matching data.
getUseRowHeaders
 
boolean
getUseRowHeaders();
Description
returns whether row headers from the cell ranges are used to find matching data or not.
setUseRowHeaders
 
void
setUseRowHeaders(
[ in ] boolean bUseRowHeaders );

Description
specifies if row headers from the cell ranges are used to find matching data.
getInsertLinks
 
boolean
getInsertLinks();
Description
returns whether links to the original data are inserted in the output area or not.
setInsertLinks
 
void
setInsertLinks(
[ in ] boolean bInsertLinks );

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

Top of Page